Kheiss/journey1

[kheiss-uwzoo]

Overview

Documentation updates for the NeMo Retriever docs site: consistent NeMo Retriever Library naming, clearer Get Started and deployment-mode guidance, a World-class performance CTA, and CTAs that explicitly call out hosted NIMs, local Hugging Face, and self-hosted options. mkdocs.yml is aligned with these content changes.

Changes by File

File	Changes
docs/docs/index.md	• Use "NeMo Retriever Library" everywhere (title, body, Applications, Related Topics). • Add Get Started section with CTA to Library Mode quickstart as the primary path for workloads <100 PDFs. • Add World-class performance link to Benchmarks & Comparison (extraction/benchmarking.md). • In Related Topics, state that embedding and reranking support hosted NIMs, local HF, and self-hosted; add "(hosted NIM, local HF, self-hosted)" to the Embedding and Reranking NIM links.
docs/docs/extraction/overview.md	• Replace generic note with Get Started tip: CTA to Library Mode quickstart and <100 PDFs recommendation.
docs/docs/extraction/quickstart-library-mode.md	• Clarify default is hosted NIMs; add that embedding/reranking can use local Hugging Face or self-hosted via custom endpoints (with FAQ link).
docs/docs/extraction/support-matrix.md	• For embedding and reranker bullets, state availability as hosted NIM, local Hugging Face, or self-hosted.
docs/docs/extraction/python-api-reference.md	• In embed() note, add that embedding supports hosted NIM (default), local Hugging Face models, or self-hosted endpoint.
docs/docs/extraction/vlm-embed.md	• Fix NeMo Retriever link to overview.md (was external URL). • Add that the page is self-hosted multimodal embedding and that text embedding/reranking also support hosted NIMs and local Hugging Face.
docs/docs/extraction/chunking.md	• Clarify Hugging Face tokenizers run locally (local HF) and are downloaded from the Hub; add link to Hugging Face Hub. • In note for default tokenizer, add "runs locally (local HF)".
docs/mkdocs.yml	• site_name: "NeMo Retriever Documentation" → "NeMo Retriever Library Documentation". • Nav top-level: "NeMo Retriever" → "NeMo Retriever Library". • Add comment that Get Started CTA points to Library Mode QuickStart for workloads <100 PDFs. • Performance nav: "Benchmarking" → "Benchmarks & Comparison" (same extraction/benchmarking.md).

Summary

• 8 files changed (7 .md, 1 mkdocs.yml).
• Naming: Public-facing copy uses "NeMo Retriever Library" (and not "nv-ingest" or abbreviations) except where migration links are kept.
• Get Started: Landing and extraction overview both point to Library Mode quickstart and recommend it for <100 PDFs.
• Deployment modes: Retrieval NIM and Hugging Face CTAs explicitly mention hosted NIMs, local HF, and self-hosted where relevant.
• Performance: Landing page includes a "World-class performance" link to the Benchmarks & Comparison doc; nav label updated to match.