docs(extraction): standardize product name casing to NeMo Retriever - #2331
Draft
kheiss-uwzoo wants to merge 1 commit into
Draft
docs(extraction): standardize product name casing to NeMo Retriever#2331kheiss-uwzoo wants to merge 1 commit into
kheiss-uwzoo wants to merge 1 commit into
Conversation
Fix product-name capitalization drift flagged by the content IA audit (Chapter 3, Naming Convention). Corrects three miscased "Nemo Retriever" occurrences to the canonical "NeMo Retriever" and retires the free-form "Nemo Retriever Extraction" variant in "Related Topics" links. - index.md: "NVIDIA Nemo Retriever" -> "NVIDIA NeMo Retriever" - extraction/vdbs.md: link text "Troubleshoot Nemo Retriever Extraction" -> "Troubleshoot NeMo Retriever" - extraction/embedding.md: same link-text fix Prose-only. No code identifiers (nemo-retriever, nemo_retriever), URLs, file paths, or link targets are changed. Strict mkdocs build passes.
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes product-name capitalization drift flagged by the content IA audit (Chapter 3 — Naming Convention). This is a small, prose-only cleanup that standardizes user-facing text on the canonical NeMo Retriever casing and retires the free-form "Nemo Retriever Extraction" variant.
This is the second in a series of scoped, audit-driven docs PRs (follows #2330).
Changes
docs/docs/index.md— "NVIDIA Nemo Retriever" -> "NVIDIA NeMo Retriever"docs/docs/extraction/vdbs.md— Related Topics link text "Troubleshoot Nemo Retriever Extraction" -> "Troubleshoot NeMo Retriever"docs/docs/extraction/embedding.md— same Related Topics link-text fixThree occurrences total; these were the only miscased
Nemo Retrieverinstances indocs/docs.Scope / safety
nemo-retriever,nemo_retriever), environment variables, URLs, file paths, or link targets are changed — only visible link text and body copy.mkdocs build --strict.Deferred (needs a naming decision, not in this PR)
The audit also recommends broader canonicalization — picking one long form (
NVIDIA NeMo Retriever Library) vs. short form (NeMo Retriever) consistently, and retiring theNRLabbreviation (defined once inoverview.md, otherwise unused). Those are editorial/branding calls left for a follow-up once the canonical form is confirmed.Test plan
mkdocs build --strictsucceeds