fix(docs): detect generated skill documentation drift#67328
fix(docs): detect generated skill documentation drift#673280xCAFEBABEx0 wants to merge 1 commit into
Conversation
|
Thanks for addressing a verified documentation-integrity gap. On current The PR changes that job to No verified blocking problems found in the reviewed change. Automated hermes-sweeper review. |
|
Automated triage review — verified against The implementation faithfully covers the #67325 spec, but there are two concerns a maintainer should weigh before merge. What's solidThe
Concern 1 — decision gate#67325 is labeled Concern 2 — mixed infra + bulk regeneration738 deletions / large additions come from a one-time re-sync of 177 skills (moved pages, new pages, catalogs, sidebar) bundled with the tooling change. That's defensible (it's what makes Cross-PR note#67327 (for #67324) currently re-includes this PR's entire changeset — 22 identical files, including a byte-identical 289-line diff of Net: strong implementation; recommend a maintainer decision-ack + de-duplication with #67327 before merge. |
Automated triage reviewReviewed against What's solid:
Catalogs/sidebar handling is correct: they're in One thing to flag — overlap with #67327 ( Verdict: the drift-check implementation itself is correct, well-tested (12 passing generator tests covering no-write, bounded output, safe cleanup, collision refusal, CLI routing), and matches the issue. The only real risk is the entanglement with #67327, which is a sequencing/scope problem rather than a defect in this code. |
What does this PR do?
Adds a read-only drift check for generated skill documentation and makes generator ownership explicit. CI now verifies committed pages, catalogs, and sidebar content instead of silently regenerating them.
Normal generation fails closed on a hand-written page collision, removes only stale pages carrying the exact ownership marker, and bounds unified diff output. The branch also commits the one-time synchronization for the 177 skills currently discovered on
main.Related Issue
Fixes #67325
Type of Change
Changes Made
website/scripts/generate-skill-docs.py --checkas a read-only verification mode.docs-site-checks.ymlto run the read-only check.mainsource tree.How to Test
scripts/run_tests.sh tests/website/test_generate_skill_docs.py.python3 website/scripts/generate-skill-docs.py.python3 website/scripts/generate-skill-docs.py --checkand confirm it reportsSkill documentation is up to date.without changing the worktree.npm run buildfromwebsite/.Checklist
Code
fix(scope):,feat(scope):, etc.)pytest tests/ -qand all tests passDocumentation & Housekeeping
docs/, docstrings)cli-config.yaml.exampleif I added/changed config keys — N/ACONTRIBUTING.mdorAGENTS.mdif I changed architecture or workflows — N/A; CI workflow and generator are updated directlyScreenshots / Logs
Skill documentation is up to date.