docs: add explicit section link anchors on cross-linked pages#2244
docs: add explicit section link anchors on cross-linked pages#2244kheiss-uwzoo wants to merge 1 commit into
Conversation
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.
Greptile SummaryThis PR adds stable
|
| 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) |
There was a problem hiding this 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.
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!
|
Superseded by combined draft PR #2245 (minimal-install de-versioning + section link anchors). |
Summary
{ #anchor }IDs to heavily cross-linked sections on the support matrix, deployment options, API reference, concepts, and document-ingestion workflow pagesprerequisites-support-matrix.md, matching the pattern already used onvdbs.mdandmultimodal-extraction.mdTest plan
cd docs && mkdocs build -f mkdocs.yml --strict(optional local verify)#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