docs(extraction): pin GitHub source links to the 26.08 tag (NVBug 6628516) - #2579
Draft
kheiss-uwzoo wants to merge 1 commit into
Draft
docs(extraction): pin GitHub source links to the 26.08 tag (NVBug 6628516)#2579kheiss-uwzoo wants to merge 1 commit into
kheiss-uwzoo wants to merge 1 commit into
Conversation
…8516) Versioned 26.08 docs were sending readers to mutable main for Helm, CLI, examples, and source. Pin those references to the 26.08 release tag and keep contribution-policy links on main.
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.
Summary
blob/mainandtree/mainGitHub links in versioned 26.08 extraction docs to the immutable26.08tag (Helm README/values, CLI, examples, source, nav, and redirects).main(contributing.md→CONTRIBUTING.md).mainadvances, 26.08 readers no longer follow newer Helm keys, defaults, examples, or source.Why this is on
mainThere is no
26.08maintenance branch. Tag26.08currently matchesupstream/main(5d9a42a57). This pin is for the 26.08 versioned docs snapshot.After
maindiverges for the next train, restore/blob/main/and/tree/main/onmain(or keep this pin only on a26.08branch) so latest docs stay evergreen.Intentional leftovers
docs/docs/extraction/contributing.mdstill points atblob/main/CONTRIBUTING.md(evergreen, per bug expected result).docs/docs/license.mdstill has fourblob/mainlinks (outside the extraction audit scope).blob/mainself-links; this PR only changes published extraction docs anddocs/mkdocs.yml.Test plan
git grepforgithub.com/NVIDIA/NeMo-Retriever/(blob|tree)/mainunderdocs/docs/extraction— onlycontributing.mdremains26.08tag URLs resolve (Helm README exists; heading IDs such as#secrets,#changing-nim-image-repository-or-tag,#recommended-minimal-install-2608are present)python -m mkdocs build --strict --config-file mkdocs.ymlfromdocs/— PASS when untracked leftover pages are not in the treeCONTRIBUTING.mdonmainpre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main
Base: upstream/main
Files: agentic-retrieval-concept.md, api-keys.md, audio-video.md, concepts.md, content-metadata.md, customize-extend.md, deployment-options.md, embedding.md, faq.md, getting-started-about.md, multimodal-extraction.md, nemo-retriever-api-reference.md, overview.md, performance_guide.md, prerequisites-support-matrix.md, releasenotes.md, troubleshoot.md, vdbs.md, workflow-agentic-retrieval.md, workflow-document-ingestion.md, workflow-e2e-blueprints.md, mkdocs.yml
see [CTAs)see [CTAs on changed files; leakage script FAIL was untracked leftovercustom-metadata.md, not in this diffdocs/docs/extraction/**/*.md+docs/mkdocs.yml)26.08tag exists and Helm heading IDs used by these links are present (95%)Code drift (not in this docs PR):
nemo_retriever/helm/README.mdand other in-repo guides still containblob/mainself-links.PR: this draft