Repository navigation
[1/2] docs: date-prefix announcement filenames - #2917
Conversation
Name announcement pages <yyyymmdd>-<slug>.rst so they sort by date, and point the index cards and README links at the new paths. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Keval Morabia <28916987+kevalmorabia97@users.noreply.github.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Description Check |  |
Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | |
The title clearly and concisely identifies the primary change: adding date prefixes to announcement filenames. |
| Docstring Coverage | |
Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (1 skipped: 1 … |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
| Security Anti-Patterns | |
The pull request changes documentation configuration, announcement filenames, links, and one optional documentation dependency. It introduces no changes under modelopt/ or examples/ Python files, … |
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (1 skipped: 1 unsupported.)
Full details: Security Anti-Patterns
-
Explanation
The pull request changes documentation configuration, announcement filenames, links, and one optional documentation dependency. It introduces no changes under
modelopt/orexamples/Python files, and therefore introduces none of the listed Python security anti-patterns. The addedsphinxext-rediraffedependency is identified in the PR description as MIT licensed, which is permissive under this check.
✨ Finishing Touches
-
📝 Generate docstrings
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
|
/ok to test c02883d |
cjluo-nv
left a comment
cjluo-nv
left a comment
There was a problem hiding this comment.
Bot review (gpt-6.1-sol) — DM the bot to share feedback.
Changes requested: the filename-only cleanup breaks all eight existing public announcement URLs without redirects.
Needs action:
- Preserve the old announcement URLs with redirects or compatibility pages pointing to the dated URLs; see the inline comment in
docs/source/index.rst. - Run a clean Sphinx HTML build and verify that all eight dated pages, index links, and legacy redirects resolve; record the results in the PR description.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2917 +/- ##
==========================================
+ Coverage 70.16% 78.91% +8.75%
==========================================
Files 659 659
Lines 74081 74081
==========================================
+ Hits 51978 58463 +6485
+ Misses 22103 15618 -6485
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Keval Morabia <28916987+kevalmorabia97@users.noreply.github.com>
|
/ok to test 5e47e2b |
Replace the custom build-finished hook with the MIT-licensed rediraffe extension, which writes the same redirect pages and warns on missing targets. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Keval Morabia <28916987+kevalmorabia97@users.noreply.github.com>
|
/ok to test 7af729f |
There was a problem hiding this comment.
Bot review (gpt-6.1-sol) — DM the bot to share feedback.
LGTM: the prior URL-compatibility and build-validation concerns are resolved; human sign-off remains for the new MIT-licensed documentation dependency.
Needs action:
- Confirm licensing approval for
sphinxext-rediraffeinpyproject.tomlbefore merging.
No action needed:
- ✔️ Resolved since the last review: all eight legacy paths have redirect mappings, and clean-build/link-validation results are recorded in the PR description.
- The dated filenames, redirect targets, index cards, and README links agree. CI installs
dev-docsand builds with--fail-on-warning; leavinguv.lockunchanged followsCONTRIBUTING.md. - Build results were reviewed as reported; I did not execute Sphinx locally.
3 participants
What does this PR do?
Type of change: documentation
Renames every announcement page to
<yyyymmdd>-<slug>.rst, using its publication date, so the pages sort by date in the source tree. The index cards and the README blog links point to the new paths. The GitHub Pages announcement's authoring note states the convention.The old URLs keep working:
docs/source/conf.pyenablessphinxext-rediraffe(MIT, added to thedev-docsgroup;uv.lockis left to the weekly bump) and maps each old page to its dated one inrediraffe_redirects. Rediraffe writes a redirect page at every old path that keeps the query and#fragment, and warns (so the--fail-on-warningdocs build fails) when a target page does not exist.Merge order: this is [1/2]; #2915 (GLM-5.3-Flash announcement) is stacked on it.
Usage
N/A (documentation)
Testing
git grepfor the old announcement paths: no references left in the repo.conf.py. The build had unrelated autodoc warnings from that environment, so it was not run with--fail-on-warning; CI's docs job does that.Before your PR is "Ready for review"
CONTRIBUTING.md: ✅sphinxext-rediraffeis MIT licensed (docs-only dependency).Additional Information
#2899 edits
qwen36-w4a4-qad.rstunder its old name; git's rename detection should carry the change over, but whichever merges second may need a rebase.🤖 Generated with Claude Code
Summary by CodeRabbit