Skip to content

Update product naming#1466

Open
kheiss-uwzoo wants to merge 11 commits intoNVIDIA:mainfrom
kheiss-uwzoo:kheiss/qa2
Open

Update product naming#1466
kheiss-uwzoo wants to merge 11 commits intoNVIDIA:mainfrom
kheiss-uwzoo:kheiss/qa2

Conversation

@kheiss-uwzoo
Copy link
Collaborator

Overview

Documentation updates from review comments on PR #1450.
This branch is one commit ahead of origin/main and aligns docs with the NeMo Retriever Library naming and the NVIDIA Ingest rename.

Changes

  1. Product naming
    Replaced standalone "NeMo Retriever" with "NeMo Retriever Library" in prose across the docs.
    Updated "NVIDIA NeMo Retriever" to "NVIDIA NeMo Retriever Library" on the index and in extraction pages.
    Left unchanged: model name "Llama 3.2 NeMo Retriever Multimodal Embedding 1B" and repo/URL identifiers (e.g. NeMo-Retriever, nemo-retriever, nv-ingest in code and paths).
  2. Navigation
    In docs/mkdocs.yml, nav section "NeMo Retriever Extraction" → "NeMo Retriever Library".
  3. Rename note
    Standardized the callout in extraction docs to:
    "NVIDIA Ingest (nv-ingest) has been renamed to the NeMo Retriever Library."
  4. Titles, links, and cross-references
    Index: title and body text use "NeMo Retriever Library"; Related Topics links updated (e.g. Text Embedding NIM, Text Reranking NIM).
    Contributing: page title and link text set to "NeMo Retriever Library".
    Extraction docs: link text and references updated (e.g. quickstart, notebooks, FAQ, user-defined functions/stages, release notes, VLM embed, nemoretriever-parse, troubleshoot, Python API).

Files changed (25)

Config: docs/mkdocs.yml
Index: docs/docs/index.md
Extraction: 23 files under docs/docs/extraction/ (e.g. overview.md, quickstart-guide.md, quickstart-library-mode.md, faq.md, notebooks.md, user-defined-functions.md, user-defined-stages.md, releasenotes-nv-ingest.md, vlm-embed.md, nemoretriever-parse.md, contributing.md, troubleshoot.md, plus other extraction topics).

Testing

No code or build logic changed; only Markdown and nav config.

Recommend a quick pass in the built docs site to confirm nav, index, and key extraction pages show "NeMo Retriever Library" and the rename note correctly.

Copy link
Collaborator Author

@kheiss-uwzoo kheiss-uwzoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed wording

@kheiss-uwzoo kheiss-uwzoo marked this pull request as ready for review March 2, 2026 21:45
@kheiss-uwzoo kheiss-uwzoo requested a review from a team as a code owner March 2, 2026 21:45
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Mar 2, 2026
@kheiss-uwzoo kheiss-uwzoo requested a review from jdye64 March 2, 2026 21:47
@kheiss-uwzoo kheiss-uwzoo changed the title Update documentation per review comments from PR #1450 Update product naming per review comments from PR #1450 Mar 5, 2026
@kheiss-uwzoo kheiss-uwzoo changed the title Update product naming per review comments from PR #1450 Update product naming Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant