chore: gate CI on the doc-style audit script#105
Merged
Conversation
CLAUDE.md and the /next-task skill both claim CI runs scripts/audit-doc-style.py, but ci.yml never invoked it -- which is how two doc width violations slipped onto trunk unnoticed. Add a doc-style job (checkout + python3 scripts/audit-doc-style.py); the script is stdlib-only so the job needs no pip install, and its non-zero exit on violations is what gates. The width violations themselves (doc/reference/cli.md, doc/usage/ run.md) were already fixed by intervening commits; the audit exits 0 on trunk today, so this lands no doc edits.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CLAUDE.md and the /next-task skill both claim CI runs scripts/audit-doc-style.py, but ci.yml never invoked it -- which is how two doc width violations slipped onto trunk unnoticed. Add a doc-style job (checkout + python3 scripts/audit-doc-style.py); the script is stdlib-only so the job needs no pip install, and its non-zero exit on violations is what gates.
The width violations themselves (doc/reference/cli.md, doc/usage/ run.md) were already fixed by intervening commits; the audit exits 0 on trunk today, so this lands no doc edits.
Summary
What does this change, and why?
Checklist
cargo fmt --all -- --checkpassescargo clippy --workspace --all-targets -- -D warningsis cleancargo test --workspacepassesdoc/updated if behavior changed (mdbook buildstill clean)Notes for reviewers
Anything worth calling out -- tricky bits, follow-ups, or intentionally out-of-scope items.