feat: add docs-review skill for documentation staleness detection#717
feat: add docs-review skill for documentation staleness detection#717csoceanu wants to merge 5 commits into
Conversation
Add a new docs-review skill to the review agent that detects stale documentation caused by code changes. The skill builds an identifier checklist from every changed file, greps documentation for matches, and evaluates candidates in two passes (quick scan then deep read). Changes: - Create skills/docs-review/SKILL.md with 6-step process - Add docs-review to review harness and agent definition - Add documentation currency as 7th review dimension - Update pr-review to delegate to docs-review after code-review Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Review: #717Head SHA: ce183f5 SummaryThis PR cleanly adds a new FindingsCriticalNone. HighNone. Medium
Low / InfoNone. FooterOutcome: comment-only Previous runReview: #717Head SHA: b27626b SummaryThis PR cleanly adds a docs-review skill as a 7th review dimension, with well-designed integration into the review agent, harness config, and pr-review orchestration. The new skill follows established patterns (frontmatter, numbered process, constraints), includes sensible false-positive safeguards (two-pass evaluation, severity cap at high, exclusion of already-modified docs and changelogs), and all cross-references and step renumbering in pr-review are correct. No security, correctness, or injection concerns were found. FindingsLow
FooterOutcome: approve Previous run (2)Review: #717Head SHA: e4633fa SummaryThis PR cleanly adds a new FindingsMedium
Info
FooterOutcome: comment-only Previous run (3)Review: #717Head SHA: 87e4dac SummaryThe PR adds a well-structured docs-review skill with a clear six-step process (identifier extraction, doc discovery, grep, two-pass evaluation, findings) and integrates it correctly into the review agent definition, harness, and pr-review orchestration skill. The skill routing, dimension numbering, step renumbering, and finding aggregation across steps are all consistent. One medium finding: the pr-review constraint section now requires docs-review completion before posting, but step 4 defines skip conditions where docs-review is intentionally not run — these two instructions contradict each other and could cause the agent to emit a spurious failure or ignore the constraint. FindingsCritical(none) High(none) Medium
Low(none) Info(none) FooterOutcome: comment-only |
Remove the skip conditions for docs-review (docs-only PRs, reverts, >200 files) since they contradicted the constraint requiring docs-review completion before posting. The skill handles edge cases internally — no docs found produces zero findings. Addresses review feedback from fullsend-ai-review. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove specific directory names from step 3 exclusion instruction - Update agent description to include documentation currency Addresses review feedback from fullsend-ai-review. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
| Find all documentation files in the repository. This includes files in | ||
| dedicated documentation directories and standalone documentation files | ||
| like README.md at any level. Explore the repository structure to | ||
| understand where documentation lives — different repos organize docs | ||
| differently. |
There was a problem hiding this comment.
So, this might blow the context window of the agent. At the very top of the skill, WDYT about adding an exhortation to encourage the agent to spin up a sub-agent to carry out this entire skill?
There was a problem hiding this comment.
@ralphbean - Great suggestion! Added a "Context management" section at the top of the skill encouraging the agent to dispatch a subagent
Site previewPreview: https://ef94a6f5-site.fullsend-ai.workers.dev Commit: |
Encourage the agent to dispatch a subagent for the docs-review process to avoid consuming the main review context window. Follows the pattern established by the retro-analysis skill. Addresses review feedback from ralphbean. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
fullsend review is working on this — view logs |
Addresses review feedback from fullsend-ai-review. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
fullsend review is working on this — view logs |
Add a new docs-review skill to the review agent that detects stale documentation caused by code changes. The skill builds an identifier checklist from every changed file, greps documentation for matches, and evaluates candidates in two passes (quick scan then deep read).
Changes: