[None][doc] Group VisualGen feature guides under one navigation entry - #19023
Conversation
Signed-off-by: Chang Liu <lc9114@gmail.com>
…verview Signed-off-by: Chang Liu <lc9114@gmail.com>
Signed-off-by: Chang Liu <lc9114@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. WalkthroughAdded a Visual Generation beta documentation index, consolidated its navigation, added license metadata, and registered Sphinx source processing for Sphinx-only sections. ChangesVisual Generation documentation
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change consolidates Visual Generation navigation without changing library behavior or existing guide URLs. It is ready to merge. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (1 skipped: 1 unsupported.)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: Chang Liu <lc9114@gmail.com>
|
Automatically added "ci: full pre-merge approved" because this PR has satisfied the required GitHub review approvals. Unresolved review conversations and other required checks remain independent merge requirements. |
|
/bot skip --comment "doc change only" |
|
PR_Github #72857 [ skip ] triggered by Bot. Commit: |
|
PR_Github #72857 [ skip ] completed with state |
Description
VisualGen CUDA Graphs, Quantized Attention, and Sparse Attention currently occupy three top-level entries under Features. Group them under one Visual Generation (Beta) landing page with a second-level menu, following the existing AutoDeploy Transforms navigation pattern.
The landing page uses ordinary Markdown links so GitHub's file preview renders the overview, guides, and related technical blogs correctly. Its hidden navigation comment is expanded by a Sphinx
source-readcallback scoped to this page, preserving the documentation site's submenu without exposing Sphinx directives in GitHub. The examples link uses the published site because its source index is generated during the documentation build.The page includes links to the model overview and both published VisualGen technical blogs: NVL72 scaling and quantization/sparse attention. Existing guide and blog contents, URLs, and heading anchors are preserved. The landing page keeps the same generated
features/visual-generation.htmlURL. This changes three documentation/build files and follows the guide split in #18792.Test Coverage
:doc:,toctree, or code blocks. Verified every relative link targets an existing repository file.nvidia_sphinx_theme, the actual root toctree, landing page, three feature guides, and the production source-read callback. Unrelated navigation destinations and blog bodies used title-only placeholders. Verified one Visual Generation entry under Features, all three nested guides, active-page expansion, breadcrumbs, landing links, and no duplicate guide list. Checked that the callback leaves other documents unchanged.main, invisualgen-quantized-attention.md(sageattention-trtllmandmxfp8--nvfp4-cutedsl--flashinfer). The full TensorRT-LLM API/C++ documentation build was not run.git diff --checkpassed. No library code or dependencies changed.PR Checklist
Please review the following before submitting your PR:
PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
If PR introduces API changes, an appropriate PR label is added - either
api-compatibleorapi-breaking. Forapi-breaking, includeBREAKINGin the PR title.Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
Update tava architecture diagram if there is a significant design change in PR.
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.
Dev Engineer Review
The PR consolidates VisualGen guides under the existing
features/visual-generation.htmlURL. The scopedsource-readcallback enables Sphinx navigation without exposing Sphinx directives in GitHub. No library code, dependencies, APIs, or existing guide content changed.QA Engineer Review
No test changes.
Per-File QA Perspective
docs/source/conf.py: Verify that the callback affects only the VisualGen document and preserves GitHub Markdown output.docs/source/features/visual-generation.md: Verify navigation and all model, example, guide, and blog links in GitHub and Sphinx.docs/source/index.rst: Verify the consolidated navigation entry, removed duplicate entries, and license metadata in the documentation build.