fix(docs): detect generated skill documentation drift - #67328
0xCAFEBABEx0 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. |
SummaryOne PR addresses #67325. #67328 adds the requested read-only drift detection and ownership safeguards, updates CI to check rather than mutate generated documentation, tests the new behavior, and synchronizes the generated pages, catalogs, and sidebar. Related pull requests
Suggested consolidationKeep #67328 open with a salvage path: preserve the generator ownership contract, read-only CI check, collision refusal, marker-gated cleanup, bounded diff reporting, and their focused tests while maintainers evaluate the large generated-baseline portion. It is the only recorded fix for #67325 and there are no competing PRs to close as duplicates. Complex graphflowchart LR
classDef open fill:#dbeafe,stroke:#1d4ed8,color:#1e3a8a
classDef merged fill:#dcfce7,stroke:#15803d,color:#14532d
classDef closed fill:#e5e7eb,stroke:#6b7280,color:#1f2937
classDef unverified fill:#f3f4f6,stroke:#9ca3af,color:#374151
classDef best stroke-width:3px,stroke:#b45309
classDef target stroke-width:3px,stroke:#4338ca
I67325(["issue #67325 (open)"])
P67328["PR #67328 (open)"]
P67328 -->|best fix| I67325
class I67325 open
class P67328 open
class P67328 best
class P67328 target
click I67325 "https://github.com/NousResearch/hermes-agent/issues/67325"
click P67328 "https://github.com/NousResearch/hermes-agent/pull/67328"
Graph: solid arrow = fixes / best fix, dashed arrow = partial or unverified (see edge label); boxed group = PRs duplicating each other; amber border = best fix; indigo border = target; gray node = closed (state tag in the node label). Cross-PR triage: Reviewed 1 pull request and 1 issue in this complex. Each diff was read against this issue; Assessment working set: 197 kB of PR diffs, 5 kB of issue/PR text, 8 kB of discussion (5 comments), 2 verify verdicts. verdicts reflect diff content, not PR titles. Part of an automated triage batch. |
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.