Skip to content

docs: rename non-FAQ question headings to statement style - #2409

Closed
kheiss-uwzoo wants to merge 2 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/statement-style-headings
Closed

docs: rename non-FAQ question headings to statement style#2409
kheiss-uwzoo wants to merge 2 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/statement-style-headings

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Rename non-FAQ question-style headings to statement-style titles per NVIDIA Template Library guidance (overview H1, root index H1, LanceDB section, MkDocs nav label).
  • Update cross-link text to match the new titles; preserve existing heading anchors so deep links keep working.
  • Leave FAQ question headings unchanged; do not change numbered TOC section labels.

Test plan

  • Confirm overview, index, and LanceDB headings are statement-style in the rendered docs.
  • Confirm FAQ page headings remain questions.
  • Spot-check nav label for overview and a few cross-links from multimodal / audio-video / troubleshoot pages.
  • Confirm anchors #what-is-nemo-retriever-library, #what-is-nvidia-nemo-retriever, and #why-lancedb still resolve.

Align overview, nav, and LanceDB section titles with NVIDIA Template Library guidance while keeping FAQ questions unchanged.
@kheiss-uwzoo
kheiss-uwzoo requested review from a team as code owners July 27, 2026 20:23
@kheiss-uwzoo
kheiss-uwzoo requested a review from drobison00 July 27, 2026 20:23
@greptile-apps

greptile-apps Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Renames non-FAQ question-style documentation headings to statement-style titles while preserving their existing anchors.

  • Updates the NeMo Retriever overview and root index H1 headings.
  • Renames the LanceDB section and its local table-of-contents label.
  • Aligns navigation and cross-link text with the renamed headings.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/docs/extraction/overview.md Renames the library overview H1 and explicitly preserves its existing generated anchor.
docs/docs/index.md Renames the root documentation H1 and explicitly preserves its existing generated anchor.
docs/docs/extraction/vdbs.md Renames the LanceDB heading and TOC label while retaining the existing explicit anchor.
docs/mkdocs.yml Updates the overview navigation label to match the renamed page heading.

Reviews (2): Last reviewed commit: "docs: capitalize Overview in statement-s..." | Re-trigger Greptile

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator Author

Folded into #2391 (same heading renames applied on that branch). Closing as duplicate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant