Skip to content

docs: add explicit section link anchors on cross-linked pages#2244

Closed
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/section-link-anchors
Closed

docs: add explicit section link anchors on cross-linked pages#2244
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/section-link-anchors

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Add stable { #anchor } IDs to heavily cross-linked sections on the support matrix, deployment options, API reference, concepts, and document-ingestion workflow pages
  • Add an "On this page" mini-TOC to prerequisites-support-matrix.md, matching the pattern already used on vdbs.md and multimodal-extraction.md
  • Follow-up to reviewer feedback to generally add more link anchors so cross-page fragments survive heading edits

Test plan

  • cd docs && mkdocs build -f mkdocs.yml --strict (optional local verify)
  • Confirm inbound links still resolve: #software-requirements, #default-helm-nims, #model-hardware-requirements, #when-to-self-host-nims, #when-to-use-nvidia-hosted-nims, #pdf-pre-splitting-for-parallel-ingest, #choose-how-you-call-the-library
  • Spot-check support matrix "On this page" links in built HTML

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.
@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners June 18, 2026 16:24
@kheiss-uwzoo kheiss-uwzoo requested a review from edknv June 18, 2026 16:24
@kheiss-uwzoo kheiss-uwzoo marked this pull request as draft June 18, 2026 16:29
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jun 18, 2026
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jun 18, 2026
@greptile-apps

greptile-apps Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds stable { #anchor } IDs to cross-linked section headings across five documentation pages (concepts.md, deployment-options.md, nemo-retriever-api-reference.md, prerequisites-support-matrix.md, workflow-document-ingestion.md) and introduces a manual "On this page" mini-TOC to prerequisites-support-matrix.md, matching the pattern already present on vdbs.md and custom-metadata.md.

  • Anchor IDs are added to all headings called out in the PR test plan; every TOC link in the new "On this page" section resolves to a matching { #anchor } in the same file.
  • One TOC entry uses a legacy anchor ID (#nemotron-ocr-v2-language-mode) that no longer matches its current heading text (OCR artifacts (Helm vs local Hugging Face)); this is intentional for backward compatibility but is not documented inline.

Confidence Score: 5/5

Documentation-only change; all anchor IDs match their TOC link targets and follow the established pattern on other doc pages.

Every { #anchor } ID added is verified against its corresponding TOC entry. The new "On this page" section follows the same structure already present on vdbs.md and custom-metadata.md. No code, config, or schema is touched.

The legacy anchor #nemotron-ocr-v2-language-mode in prerequisites-support-matrix.md (line 90) deserves a quick scan to confirm all inbound links that use it still expect that ID rather than a newer variant.

Important Files Changed

Filename Overview
docs/docs/extraction/prerequisites-support-matrix.md Adds anchors to all major sections and introduces a manual "On this page" TOC; one TOC entry uses a legacy anchor ID that differs from its display text (OCR artifacts → #nemotron-ocr-v2-language-mode).
docs/docs/extraction/concepts.md Adds explicit { #anchor } IDs to all five section headings; no content changes.
docs/docs/extraction/deployment-options.md Adds { #when-to-use-nvidia-hosted-nims } and { #when-to-self-host-nims } anchors to two section headings; no content changes.
docs/docs/extraction/nemo-retriever-api-reference.md Adds { #pdf-pre-splitting-for-parallel-ingest } anchor to the first section heading; no content changes.
docs/docs/extraction/workflow-document-ingestion.md Adds { #ingest-and-extract } and { #choose-how-you-call-the-library } anchors to two section headings; no content changes.
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
docs/docs/extraction/prerequisites-support-matrix.md:11
**TOC display text diverges from section heading**

The "On this page" entry reads `OCR artifacts (Helm vs local Hugging Face)` but links to `#nemotron-ocr-v2-language-mode`, which derives from an older heading title. While the anchor itself is intentionally stable, a reader editing this file in the future may not understand why the anchor ID says "nemotron-ocr-v2-language-mode." A brief inline comment (e.g., `<!-- stable anchor, kept from previous heading -->`) on line 90 would make the intent self-documenting.

Reviews (1): Last reviewed commit: "docs: add explicit section link anchors ..." | Re-trigger Greptile

- [Hardware Requirements](#hardware-requirements)
- [Core and Advanced Pipeline Features](#core-and-advanced-pipeline-features)
- [Default Helm NIMs](#default-helm-nims)
- [OCR artifacts (Helm vs local Hugging Face)](#nemotron-ocr-v2-language-mode)

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.

P2 TOC display text diverges from section heading

The "On this page" entry reads OCR artifacts (Helm vs local Hugging Face) but links to #nemotron-ocr-v2-language-mode, which derives from an older heading title. While the anchor itself is intentionally stable, a reader editing this file in the future may not understand why the anchor ID says "nemotron-ocr-v2-language-mode." A brief inline comment (e.g., <!-- stable anchor, kept from previous heading -->) on line 90 would make the intent self-documenting.

Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/docs/extraction/prerequisites-support-matrix.md
Line: 11

Comment:
**TOC display text diverges from section heading**

The "On this page" entry reads `OCR artifacts (Helm vs local Hugging Face)` but links to `#nemotron-ocr-v2-language-mode`, which derives from an older heading title. While the anchor itself is intentionally stable, a reader editing this file in the future may not understand why the anchor ID says "nemotron-ocr-v2-language-mode." A brief inline comment (e.g., `<!-- stable anchor, kept from previous heading -->`) on line 90 would make the intent self-documenting.

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

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator Author

Superseded by combined draft PR #2245 (minimal-install de-versioning + section link anchors).

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