Open
Conversation
kheiss-uwzoo
commented
Mar 2, 2026
Collaborator
Author
kheiss-uwzoo
left a comment
There was a problem hiding this comment.
changed wording
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
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.
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
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).
In docs/mkdocs.yml, nav section "NeMo Retriever Extraction" → "NeMo Retriever Library".
Standardized the callout in extraction docs to:
"NVIDIA Ingest (nv-ingest) has been renamed to the NeMo Retriever Library."
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.