docs: section anchors, API crosslinks, and 26.05 link hygiene#2245
Closed
kheiss-uwzoo wants to merge 5 commits into
Closed
docs: section anchors, API crosslinks, and 26.05 link hygiene#2245kheiss-uwzoo wants to merge 5 commits into
kheiss-uwzoo wants to merge 5 commits into
Conversation
Rename the Helm README minimal-install section, keep a legacy #recommended-minimal-install-2605 alias, point extraction docs at blob/main, and use version-neutral prose in chart default notes.
Keep PR NVIDIA#2243 scoped to minimal-install de-versioning only; the support matrix anchor was not renamed on main.
Add stable { #anchor } IDs and an on-page TOC to heavily linked extraction
docs so cross-page fragments survive heading edits and match vdbs.md style.
This was referenced Jun 18, 2026
Add same-section links to nemo-retriever-api-reference.md on extraction pages where python fences lacked an adjacent API guide crosslink.
2 tasks
kheiss-uwzoo
changed the title
Published NRL docs target the 26.05 train; keep (26.05) labels and 26.05-pinned Helm URLs while section anchors and API crosslinks remain.
kheiss-uwzoo
changed the title
This was referenced Jun 22, 2026
Collaborator
Author
|
Superseded by combined draft PR #2257 (H200 support matrix + anchors/crosslinks batch). |
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
Combined draft for doc hygiene follow-ups (supersedes #2243, #2244, and #2246). Separate from #2166, #2195, and #2203 — do not mix OpenShift, metadata consolidation, or #2194 backport work here.
Section link anchors
{ #anchor }IDs to heavily cross-linked extraction pagesprerequisites-support-matrix.md(matchesvdbs.md/multimodal-extraction.md)Python snippet → API guide crosslinks
nemo-retriever-api-reference.mdadjacent to python fences onembedding.md,audio-video.md,custom-metadata.md, andnimclient.md26.05 release labels
26.5.0on docs.nvidia.com);(26.05)labels andblob/26.05Helm links are intentional until the next doc versionFiles changed
nemo_retriever/helm/README.mddocs/docs/extraction/deployment-options.mddocs/docs/extraction/prerequisites-support-matrix.mddocs/docs/extraction/concepts.mddocs/docs/extraction/nemo-retriever-api-reference.mddocs/docs/extraction/workflow-document-ingestion.mddocs/docs/extraction/embedding.mddocs/docs/extraction/audio-video.mddocs/docs/extraction/custom-metadata.mddocs/docs/extraction/nimclient.mdTest plan
cd docs && mkdocs build -f mkdocs.yml --strict#recommended-minimal-install-2605,#image-captioning-2605,#software-requirements,#when-to-self-host-nims,#pdf-pre-splitting-for-parallel-ingestresolve in built HTML