[https://nvbugs/6633929][fix] Repoint all three links to the live versioned page and remove the now-unneeded… - #18016
Conversation
|
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 (2)
💤 Files with no reviewable changes (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; 11 remain after this review. WalkthroughThe PR updates three XGrammar structural-tag documentation links and removes the related ChangesDocumentation link and URL validation update
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This PR only updates three documentation links and removes the waiver for the fixed URL check; no actionable merge-blocking risk remains. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description explains the root cause, the solution, the affected test, and the test plan. It does not reproduce the template headings or checklist, but it provides the required change and validation context. Full details: Docstring CoverageExplanation 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)
Comment |
brnguyen2
left a comment
There was a problem hiding this comment.
Approving — the comments below are optional touch-ups, not blockers.
Couldn't verify the new URLs from this environment (outbound HTTP is blocked here), so the 200-vs-404 check rests on CI's test_doc.py::test_url_validity run — worth confirming that stage actually passed before merging, since the waiver removal makes the doc test gating again.
|
|
||
| TensorRT LLM supports two grammar backends: | ||
| * [XGrammar](https://github.com/mlc-ai/xgrammar/blob/v0.1.21/python/xgrammar/matcher.py#L341-L350): Supports JSON schema, regular expression, EBNF and [structural tag](https://xgrammar.mlc.ai/docs/structural_tag/structural_tag_api.html). | ||
| * [XGrammar](https://github.com/mlc-ai/xgrammar/blob/v0.1.21/python/xgrammar/matcher.py#L341-L350): Supports JSON schema, regular expression, EBNF and [structural tag](https://xgrammar.mlc.ai/docs/latest/structural_tag/structural_tag.html). |
There was a problem hiding this comment.
The structural-tag link now targets /docs/latest/, which will silently drift (or 404 again) whenever XGrammar reorganizes docs — this is the second such breakage. The adjacent source link on this same line still pins v0.1.21 while requirements.txt pins xgrammar==0.1.32. Consider pointing both at the pinned version (a versioned docs path if XGrammar publishes one) so the docs match the version actually shipped.
6c275ef to
0b122fa
Compare
XGrammar restructured its docs site: flat /docs/<page> paths moved under /docs/latest/<page>, and structural_tag_api.html became structural_tag.html. The old URL now 404s, failing test_doc.py::test_url_validity. Signed-off-by: trtllm-agent <296075020+trtllm-agent@users.noreply.github.com>
Signed-off-by: trtllm-agent <296075020+trtllm-agent@users.noreply.github.com>
0b122fa to
59f5c17
Compare
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
Summary
/docs/<page>to versioned/docs/latest/<page>and renamedstructural_tag_api.htmltostructural_tag.html, so the three links inguided-decoding.mdreturn a hard HTTP 404.waives.txtentry for nvbugs/6633929.pytest tests/integration/defs/test_doc.py::test_url_validity -vTest plan
Links
Dev Engineer Review
guided-decoding.mdto versioned/docs/latest/paths.structural_tag_api.htmltostructural_tag.html.nvbugs/6633929waiver.test_doc.py::test_url_validity.QA Engineer Review
tests/integration/test_lists/waives.txt.test_doc.py::test_url_validityentry.test-db/orqa/files were modified.