docs(26.05): reconcile release docs from main by kheiss-uwzoo · Pull Request #2311 · NVIDIA/NeMo-Retriever

kheiss-uwzoo · 2026-07-07T21:27:52Z

Summary

Sync scoped 26.5.0 documentation from main into 26.05 so the release branch becomes the source of truth for official docs.nvidia.com publishing.
Includes extraction pages, docs/mkdocs.yml, and nemo_retriever README/CLI/Helm docs only.
Removes pages deleted on main (custom-metadata.md, nimclient.md, integrations-langchain-llamaindex-haystack.md) and adds pages added on main (customize-extend.md, starter-kits.md).

Why

Per release process clarification: 26.05 is the source of truth for live 26.5.0 docs. main has accumulated Jun/Jul documentation fixes during stabilization; this PR reconciles those into the release branch before workflow PRs #2308, #2309, and #2310 are merged.

Scope

Docs-only. No workflow, runtime code, Helm templates, or lockfile changes.

Test plan

Verified PR scope is limited to published documentation paths.
After merge: run docs.nvidia.com publish workflow (dry-run first) from main once fix(docs): publish docs.nvidia.com from 26.05 branch #2310 lands.
Hold fix(ci): build nightlies from 26.05 #2308, fix(ci): enable manual 26.05 container publish #2309, and fix(docs): publish docs.nvidia.com from 26.05 branch #2310 as drafts until this PR merges.

Sync scoped 26.5.0 documentation from main into 26.05 so the release branch matches the Jun/Jul doc fixes before docs.nvidia.com publishes from 26.05. Includes extraction pages, mkdocs.yml, and nemo_retriever README/CLI/Helm docs only.

greptile-apps · 2026-07-07T21:30:49Z

Greptile Summary

This PR reconciles the 26.05 release documentation with the current published docs. The main changes are:

Updates extraction docs, API references, and cross-links.
Adds the new customization and starter-kit pages.
Removes older extraction pages that moved or were replaced.
Refreshes the NeMo Retriever README, CLI docs, and Helm README.

Confidence Score: 4/5

This is close, but the deployment docs should be fixed before merging.

The primary Helm handoff can still send release users to branch-mismatched chart docs.
The Helm README still presents unsupported answer-generation settings as usable chart inputs.
Previously broken import examples appear corrected in the latest docs.

docs/docs/extraction/deployment-options.md; nemo_retriever/helm/README.md

Important Files Changed

Filename	Overview
docs/docs/extraction/deployment-options.md	Updates deployment guidance and release links, but the main Helm entry still targets the wrong branch.
nemo_retriever/helm/README.md	Aligns several chart image references with 26.05, but still documents unsupported answer-generation chart settings.
nemo_retriever/README.md	Updates library examples to use import paths that match the 26.05 package layout.
docs/docs/extraction/audio-video.md	Updates ASR documentation to use the release package path for ASR parameters.
docs/docs/extraction/nemo-retriever-api-reference.md	Updates API reference paths to existing release modules.

Prompt To Fix All With AI

Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
docs/docs/extraction/deployment-options.md:21
**Helm Link Skew** This supported Helm entry still sends 26.05 readers to the `main` branch README and chart tree. The page later uses `26.05` links for air-gapped deployment, but users who start from this primary Helm link can still copy chart values, service names, or image inventory from a different branch and apply instructions that do not match the release chart.

### Issue 2 of 2
nemo_retriever/helm/README.md:371
**Answer LLM Unsupported** The new caveat says `answer_llm` is not in this chart, but the section still documents `nimOperator.answer_llm.enabled`, image inventory, and service configuration as chart inputs. This branch has no matching values block or NIM template, so Helm can accept those keys and finish without creating the advertised answer-generation service.

_{Reviews (5): Last reviewed commit: "docs(26.05): flag answer_llm as not in t..." | Re-trigger Greptile}

Import ASRParams from nemo_retriever.params.models instead of the non-existent nemo_retriever.common.params.models, which would raise ModuleNotFoundError when users copy the Parakeet ASR workflow.

Point mkdocstrings at nemo_retriever.retriever and nemo_retriever.params (the modules that exist in this branch) so the API reference renders, and pin the deployment-options minimal-install Helm README link to the 26.05 branch to avoid chart drift from main.

Fix import paths (nemo_retriever.io, nemo_retriever.retriever), correct OCR NIM to nemotron-ocr-v1:1.3.0 and VL reranker tag to 1.11.0 to match the 26.05 chart values, and pin deployment-options air-gap/Helm handoff links to the 26.05 branch. Addresses Greptile review comments on PR 2311.

The 26.05 chart ships no answer_llm values block, NIM template, or serviceConfig.llm keys, so the advertised answer-generation flag has no effect on this chart. Add a note softening the operator-managed answer LLM claims until the chart matches. Addresses Greptile review comment on PR 2311.

greptile-apps · 2026-07-07T22:35:56Z

@@ -19,24 +19,16 @@ Build and run the NeMo Retriever service image with the [Docker service image gu

 1. [Pre-Requisites & Support Matrix](prerequisites-support-matrix.md)
 2. **NeMo Retriever Helm chart (supported):** [Deploy (Helm chart)](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) — sources in [`nemo_retriever/helm`](https://github.com/NVIDIA/NeMo-Retriever/tree/main/nemo_retriever/helm) on GitHub


Helm Link Skew This supported Helm entry still sends 26.05 readers to the main branch README and chart tree. The page later uses 26.05 links for air-gapped deployment, but users who start from this primary Helm link can still copy chart values, service names, or image inventory from a different branch and apply instructions that do not match the release chart.

Prompt To Fix With AI

This is a comment left during a code review. Path: docs/docs/extraction/deployment-options.md Line: 21 Comment: **Helm Link Skew** This supported Helm entry still sends 26.05 readers to the `main` branch README and chart tree. The page later uses `26.05` links for air-gapped deployment, but users who start from this primary Helm link can still copy chart values, service names, or image inventory from a different branch and apply instructions that do not match the release chart. How can I resolve this? If you propose a fix, please make it concise.

greptile-apps · 2026-07-07T22:35:57Z


+#### Answer generation (operator-managed LLM) { #answer-generation-llm }
+
+> **Note:** Operator-managed answer generation is not included in the 26.05 chart. This branch ships no `answer_llm` values block or NIM template and no `serviceConfig.llm` keys, so `--set nimOperator.answer_llm.enabled=true` has no effect on this chart. The configuration described in this section applies to a later chart release; do not rely on it for a 26.05 deployment.


Answer LLM Unsupported The new caveat says answer_llm is not in this chart, but the section still documents nimOperator.answer_llm.enabled, image inventory, and service configuration as chart inputs. This branch has no matching values block or NIM template, so Helm can accept those keys and finish without creating the advertised answer-generation service.

Prompt To Fix With AI

This is a comment left during a code review. Path: nemo_retriever/helm/README.md Line: 371 Comment: **Answer LLM Unsupported** The new caveat says `answer_llm` is not in this chart, but the section still documents `nimOperator.answer_llm.enabled`, image inventory, and service configuration as chart inputs. This branch has no matching values block or NIM template, so Helm can accept those keys and finish without creating the advertised answer-generation service. How can I resolve this? If you propose a fix, please make it concise.

kheiss-uwzoo · 2026-07-08T18:55:00Z

Closing: superseded by the scoped 26.5.0 reconcile in #2313 (merged).

This umbrella PR ported main's information architecture wholesale onto 26.05 (new pages, nav renumbering, page consolidation, module-path reorg, blob/main link retargeting). After review against the 26.05 release surface, that approach was rejected in favor of 26.5.0 behavior only.

#2313 landed the genuine June–July doc fixes (4 files: chart modality, hardware matrix, OOM guidance) without adopting main-only structure. The split PRs #2314–#2316 were triaged the same way and are being closed for the same reason.

No further reconcile work is planned on this umbrella path.

docs(26.05): reconcile release docs from main

8e4db66

Sync scoped 26.5.0 documentation from main into 26.05 so the release branch matches the Jun/Jul doc fixes before docs.nvidia.com publishes from 26.05. Includes extraction pages, mkdocs.yml, and nemo_retriever README/CLI/Helm docs only.

kheiss-uwzoo requested review from a team as code owners July 7, 2026 21:27

kheiss-uwzoo requested review from ChrisJar and removed request for a team July 7, 2026 21:27

greptile-apps Bot reviewed Jul 7, 2026

View reviewed changes

docs(26.05): fix ASRParams import path in audio-video examples

830c0bd

Import ASRParams from nemo_retriever.params.models instead of the non-existent nemo_retriever.common.params.models, which would raise ModuleNotFoundError when users copy the Parakeet ASR workflow.

greptile-apps Bot reviewed Jul 7, 2026

View reviewed changes

Comment thread nemo_retriever/README.md Outdated

Comment thread nemo_retriever/README.md Outdated

Comment thread docs/docs/extraction/deployment-options.md Outdated

Comment thread nemo_retriever/helm/README.md Outdated

greptile-apps Bot reviewed Jul 7, 2026

View reviewed changes

Comment thread nemo_retriever/README.md

Comment thread nemo_retriever/helm/README.md Outdated

Comment thread nemo_retriever/helm/README.md

Comment thread docs/docs/extraction/deployment-options.md

Comment thread docs/docs/extraction/deployment-options.md

greptile-apps Bot reviewed Jul 7, 2026

View reviewed changes

kheiss-uwzoo marked this pull request as draft July 7, 2026 23:18

kheiss-uwzoo self-assigned this Jul 7, 2026

kheiss-uwzoo added 26.05 docbuild doc Improvements or additions to documentation labels Jul 7, 2026

kheiss-uwzoo closed this Jul 8, 2026

		@@ -19,24 +19,16 @@ Build and run the NeMo Retriever service image with the [Docker service image gu

		1. [Pre-Requisites & Support Matrix](prerequisites-support-matrix.md)
		2. NeMo Retriever Helm chart (supported): [Deploy (Helm chart)](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) — sources in [`nemo_retriever/helm`](https://github.com/NVIDIA/NeMo-Retriever/tree/main/nemo_retriever/helm) on GitHub


		#### Answer generation (operator-managed LLM) { #answer-generation-llm }

		> Note: Operator-managed answer generation is not included in the 26.05 chart. This branch ships no `answer_llm` values block or NIM template and no `serviceConfig.llm` keys, so `--set nimOperator.answer_llm.enabled=true` has no effect on this chart. The configuration described in this section applies to a later chart release; do not rely on it for a 26.05 deployment.

Uh oh!

Conversation

kheiss-uwzoo commented Jul 7, 2026

Summary

Why

Scope

Test plan

Uh oh!

greptile-apps Bot commented Jul 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 4/5

Important Files Changed

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greptile-apps Bot Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

kheiss-uwzoo commented Jul 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

greptile-apps Bot commented Jul 7, 2026 •

edited

Loading