Skip to content

docs: drop 26.05 labels from minimal-install links on main#2243

Draft
kheiss-uwzoo wants to merge 5 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/deversion-minimal-install-main
Draft

docs: drop 26.05 labels from minimal-install links on main#2243
kheiss-uwzoo wants to merge 5 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/deversion-minimal-install-main

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Rename the Helm README Recommended minimal install section for main; keep a legacy #recommended-minimal-install-2605 span so existing bookmarks still resolve.
  • Point deployment-options.md and prerequisites-support-matrix.md minimal-install cross-links at blob/main with version-neutral link text.
  • Replace “26.05 installs” chart-default prose with “default installs” in the Helm README values table.

Follow-up to maintainer feedback on #2166 and #2203 — keeps OpenShift and extraction doc-sync PRs scoped to their original intent.

Test plan

  • Confirm #recommended-minimal-install-2605 still resolves on the Helm README
  • Spot-check deployment-options.md and matrix optional-NIM paragraph link to main Helm README
  • Verify no (26.05) remains in minimal-install link labels on the three changed files

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.
@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners June 16, 2026 21:20
@kheiss-uwzoo kheiss-uwzoo requested a review from nkmcalli June 16, 2026 21:20
@greptile-apps

greptile-apps Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR drops the (26.05) version label from the Recommended minimal install section heading in the Helm README and re-points the two doc cross-links in deployment-options.md and prerequisites-support-matrix.md from blob/26.05 to blob/main.

  • Helm README heading renamed to ### Recommended minimal install { #recommended-minimal-install } with a <span id="recommended-minimal-install-2605"></span> block added to preserve backward-compatible bookmark resolution.
  • Both doc cross-links (deployment-options.md line 25, prerequisites-support-matrix.md line 97) updated to blob/main/…#recommended-minimal-install-2605; the nim-operator-sub-stack link in the matrix file is also rebased to blob/main.
  • Three values-table rows in the Helm README replace "26.05 installs" prose with "default installs".

Confidence Score: 5/5

Documentation-only change with no code impact; all referenced anchors resolve correctly on main.

All three files are pure Markdown docs. The legacy #recommended-minimal-install-2605 span is preserved so existing bookmarks still resolve, all internal fragment links in the README continue to target that span, and both external doc links now correctly point to blob/main. There are no code, config, or schema changes.

No files require special attention.

Important Files Changed

Filename Overview
nemo_retriever/helm/README.md Section heading renamed from 'Recommended minimal install (26.05)' to 'Recommended minimal install'; legacy span anchor added for backward compat; three values-table rows updated from '26.05 installs' to 'default installs'; internal links updated to match.
docs/docs/extraction/deployment-options.md Minimal-install cross-link updated from blob/26.05 to blob/main with version-neutral text; '(26.05)' removed from link label and surrounding prose.
docs/docs/extraction/prerequisites-support-matrix.md Two links updated from blob/26.05 to blob/main (minimal-install and NIM Operator sub-stack); '26.05 production' phrasing replaced with 'production deployments'.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["deployment-options.md\nminimal-install link"] -->|blob/main + #recommended-minimal-install-2605| C
    B["prerequisites-support-matrix.md\nminimal-install link"] -->|blob/main + #recommended-minimal-install-2605| C
    C["helm/README.md\n### Recommended minimal install\n{ #recommended-minimal-install }"]
    C --> D["span id='recommended-minimal-install-2605'\n(legacy anchor — preserves old bookmarks)"]
    E["Internal README links\n(lines 191, 307, 399)"] -->|#recommended-minimal-install-2605| D
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A["deployment-options.md\nminimal-install link"] -->|blob/main + #recommended-minimal-install-2605| C
    B["prerequisites-support-matrix.md\nminimal-install link"] -->|blob/main + #recommended-minimal-install-2605| C
    C["helm/README.md\n### Recommended minimal install\n{ #recommended-minimal-install }"]
    C --> D["span id='recommended-minimal-install-2605'\n(legacy anchor — preserves old bookmarks)"]
    E["Internal README links\n(lines 191, 307, 399)"] -->|#recommended-minimal-install-2605| D
Loading

Reviews (4): Last reviewed commit: "docs: restore caption links to #image-ca..." | Re-trigger Greptile

Comment thread nemo_retriever/helm/README.md Outdated
Comment on lines 493 to 494
[Image captioning — NIM and hardware](https://docs.nvidia.com/nemo/retriever/latest/extraction/prerequisites-support-matrix/#image-captioning-nim-hardware)
for the product matrix.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Broken fragment: #image-captioning-nim-hardware doesn't exist

The link target #image-captioning-nim-hardware was introduced here (and again at line ~1156) but prerequisites-support-matrix.md still uses the explicit anchor { #image-captioning-2605 } — that section heading was not renamed in this PR. Any reader clicking this link on docs.nvidia.com will land on a broken fragment. The correct target remains #image-captioning-2605.

Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/helm/README.md
Line: 493-494

Comment:
**Broken fragment: `#image-captioning-nim-hardware` doesn't exist**

The link target `#image-captioning-nim-hardware` was introduced here (and again at line ~1156) but `prerequisites-support-matrix.md` still uses the explicit anchor `{ #image-captioning-2605 }` — that section heading was not renamed in this PR. Any reader clicking this link on `docs.nvidia.com` will land on a broken fragment. The correct target remains `#image-captioning-2605`.

How can I resolve this? If you propose a fix, please make it concise.

Comment on lines 1156 to 1157
- For **offline captioning**, enable
`nimOperator.nemotron_3_nano_omni_30b_a3b_reasoning` and point the pipeline

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Same broken fragment as line 493

This second occurrence also points to #image-captioning-nim-hardware, which doesn't exist in the published prerequisites-support-matrix page. The existing anchor #image-captioning-2605 should be used until the section heading in prerequisites-support-matrix.md is actually renamed to match.

Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/helm/README.md
Line: 1156-1157

Comment:
**Same broken fragment as line 493**

This second occurrence also points to `#image-captioning-nim-hardware`, which doesn't exist in the published `prerequisites-support-matrix` page. The existing anchor `#image-captioning-2605` should be used until the section heading in `prerequisites-support-matrix.md` is actually renamed to match.

How can I resolve this? If you propose a fix, please make it concise.

@kheiss-uwzoo kheiss-uwzoo self-assigned this Jun 17, 2026
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jun 17, 2026
Document GitHub Pages to docs.nvidia.com upload for release 26.05 with
explicit 26.5.0 S3 paths, and align caption cross-links with the Helm
README anchor rename from NVIDIA#2243.
Keep PR NVIDIA#2243 scoped to minimal-install de-versioning only; the support
matrix anchor was not renamed on main.
@kheiss-uwzoo kheiss-uwzoo marked this pull request as draft June 17, 2026 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant