Skip to content

[https://nvbugs/6633929][fix] Fix XGrammar structural tag doc links and pin the source link - #18430

Merged
nv-guomingz merged 1 commit into
NVIDIA:mainfrom
nv-guomingz:user/guomingz/fix_nvbug_6633929
Aug 31, 2026
Merged

[https://nvbugs/6633929][fix] Fix XGrammar structural tag doc links and pin the source link#18430
nv-guomingz merged 1 commit into
NVIDIA:mainfrom
nv-guomingz:user/guomingz/fix_nvbug_6633929

Conversation

@nv-guomingz

@nv-guomingz nv-guomingz commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Description

Supersedes #18016 (its two commits are included), addressing the review feedback on top:

  • Repoint the three structural-tag tutorial links from the removed https://xgrammar.mlc.ai/docs/structural_tag/structural_tag_api.html (404) to the live https://xgrammar.mlc.ai/docs/latest/structural_tag/structural_tag.html, and remove the now-unneeded test_doc.py::test_url_validity waiver. (from [https://nvbugs/6633929][fix] Repoint all three links to the live versioned page and remove the now-unneeded… #18016)
  • Pin the XGrammar backend source link to the shipped version: v0.1.21 -> v0.1.32, matching xgrammar==0.1.32 in requirements.txt. The old anchor matcher.py#L341-L350 no longer marked anything relevant even at v0.1.21; the link now targets compiler.py#L144-L290, the GrammarCompiler methods for JSON schema, regex, structural tag and EBNF.
  • The tutorial links stay on /docs/latest/ because XGrammar publishes no versioned doc paths (/docs/v0.1.32/ and /docs/0.1.32/ both 404; verified).

Verification

All three URL forms verified with curl: new tutorial link and the v0.1.32 compiler.py link return 200; the versioned doc-path variants 404.

🤖 Generated with Claude Code

Dev Engineer Review

  • Updated structural-tag tutorial links to the live /docs/latest/structural_tag/structural_tag.html path.
  • Updated the XGrammar source link to xgrammar==0.1.32 and compiler.py#L144-L290.
  • Removed the obsolete test_doc.py::test_url_validity waiver.
  • The changes are limited to documentation links and one test-list entry.
  • The link updates are consistent with the documented XGrammar version and verified HTTP 200 responses.

QA Engineer Review

  • Removed test_doc.py::test_url_validity from tests/integration/test_lists/waives.txt.
  • No test-db/ or qa/ files were modified.
  • The test-list format remains valid, and the removed entry is no longer waived.
  • Verdict: needs follow-up because CBTS coverage data is unavailable.

@nv-guomingz
nv-guomingz requested a review from a team as a code owner August 31, 2026 06:16
@nv-guomingz

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

…nd pin the source link

Repoint the three structural-tag tutorial links from the removed
docs/structural_tag/structural_tag_api.html (404) to the live
docs/latest/structural_tag/structural_tag.html and drop the stale
test_doc.py::test_url_validity waiver. Also pin the backend source link
to the shipped version (v0.1.21 -> v0.1.32, matching requirements.txt)
and retarget it to compiler.py#L144-L290, the GrammarCompiler methods
for JSON schema, regex, structural tag and EBNF; the old
matcher.py#L341-L350 anchor no longer marked anything relevant. The
tutorial links stay on /docs/latest/ because XGrammar publishes no
versioned doc paths.

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>
@nv-guomingz
nv-guomingz force-pushed the user/guomingz/fix_nvbug_6633929 branch from 2f551de to 1685bbe Compare August 31, 2026 06:18
@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Review 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: 138d3f05-4d21-49fd-93e8-aed595e81e94

📥 Commits

Reviewing files that changed from the base of the PR and between f9d11b2 and 2f551de.

📒 Files selected for processing (2)
  • docs/source/features/guided-decoding.md
  • tests/integration/test_lists/waives.txt
💤 Files with no reviewable changes (1)
  • tests/integration/test_lists/waives.txt

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


Walkthrough

The pull request updates XGrammar links in the guided-decoding documentation and removes the URL validation test waiver.

Changes

Guided decoding documentation

Layer / File(s) Summary
Update documentation links and URL validation
docs/source/features/guided-decoding.md, tests/integration/test_lists/waives.txt
The documentation now uses current XGrammar compiler and structural-tag tutorial links. The test_doc.py::test_url_validity waiver was removed.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 2f551

The change updates broken documentation links and aligns the source reference with the shipped XGrammar version; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: bowenfu

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required NVBugs and type format and clearly summarizes the documentation-link fixes.
Description check ✅ Passed The description clearly explains the documentation and source-link changes and includes verification results. It does not use the exact Test Coverage or PR Checklist sections, but the provided verific…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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: Description check

Explanation

The description clearly explains the documentation and source-link changes and includes verification results. It does not use the exact Test Coverage or PR Checklist sections, but the provided verification is sufficient for this documentation-only change.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@nv-guomingz

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #70271 [ run ] triggered by Bot. Commit: 1685bbe Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #70272 [ run ] triggered by Bot. Commit: 1685bbe Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #70271 [ run ] completed with state ABORTED. Commit: 1685bbe

Link to invocation

@nv-guomingz
nv-guomingz enabled auto-merge (squash) August 31, 2026 06:49
@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #70272 [ run ] completed with state SUCCESS. Commit: 1685bbe
/LLM/main/L0_MergeRequest_PR pipeline #57519 completed with status: 'SUCCESS'

CI Report

Link to invocation

@nv-guomingz
nv-guomingz merged commit 2ca8aae into NVIDIA:main Aug 31, 2026
8 checks passed
@nv-guomingz
nv-guomingz deleted the user/guomingz/fix_nvbug_6633929 branch September 1, 2026 14:20
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.

3 participants