Skip to content

[None][doc] Group VisualGen feature guides under one navigation entry - #19023

Merged
chang-l merged 4 commits into
NVIDIA:mainfrom
chang-l:codex/visual-generation-feature-navigation
Sep 11, 2026
Merged

chang-l merged 4 commits into
NVIDIA:mainfrom
chang-l:codex/visual-generation-feature-navigation

Conversation

@chang-l

@chang-l chang-l commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

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-read callback 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.html URL. This changes three documentation/build files and follows the guide split in #18792.

Test Coverage

  • Repository pre-commit hooks and the DCO commit-message check passed for the changed files.
  • Rendered the landing page with GitHub's Markdown API: seven normal links, five list items, and no visible :doc:, toctree, or code blocks. Verified every relative link targets an existing repository file.
  • Built a focused Sphinx HTML preview using 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.
  • The focused build reports only the same two pre-existing anchor warnings as unchanged main, in visualgen-quantized-attention.md (sageattention-trtllm and mxfp8--nvfp4-cutedsl--flashinfer). The full TensorRT-LLM API/C++ documentation build was not run.
  • git diff --check passed. 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-compatible or api-breaking. For api-breaking, include BREAKING in 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.html URL. The scoped source-read callback 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.

…verview

Signed-off-by: Chang Liu <lc9114@gmail.com>
Signed-off-by: Chang Liu <lc9114@gmail.com>
@chang-l
chang-l marked this pull request as ready for review September 10, 2026 20:34
@chang-l
chang-l requested a review from a team as a code owner September 10, 2026 20:34
@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: ad4a04fe-82a6-4f39-9420-52d11e9eb8d1

📥 Commits

Reviewing files that changed from the base of the PR and between 5b28689 and e764ba4.

📒 Files selected for processing (1)
  • docs/source/features/visual-generation.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/source/features/visual-generation.md

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.


Walkthrough

Added a Visual Generation beta documentation index, consolidated its navigation, added license metadata, and registered Sphinx source processing for Sphinx-only sections.

Changes

Visual Generation documentation

Layer / File(s) Summary
Documentation index and Visual Generation page
docs/source/features/visual-generation.md, docs/source/index.rst
Added the Visual Generation beta page with feature links, model references, examples, and technical blog links. Updated the index and added SPDX and Apache-2.0 metadata.
Sphinx navigation processing
docs/source/conf.py
Added and registered a source-read handler that removes Sphinx-only comment wrappers from the Visual Generation page.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to e764b

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)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning 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… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: grouping VisualGen feature guides under one navigation entry.
Description check ✅ Passed The description includes the required Description, Test Coverage, and PR Checklist sections. It clearly explains the purpose, implementation, scope, and validation results.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

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.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

Signed-off-by: Chang Liu <lc9114@gmail.com>
@github-actions

Copy link
Copy Markdown

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.

@chang-l

chang-l commented Sep 11, 2026

Copy link
Copy Markdown
Collaborator Author

/bot skip --comment "doc change only"

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #72857 [ skip ] triggered by Bot. Commit: e764ba4 Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #72857 [ skip ] completed with state SUCCESS. Commit: e764ba4
Skipping testing for commit e764ba4

Link to invocation

@chang-l
chang-l merged commit 4476ee3 into NVIDIA:main Sep 11, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants