Docs agent

Docs Freshness

Details

Runs on every pull request, on GitHub

Agent Prompt

Reviews every documentation file a GitHub PR touches — reader-facing docs (READMEs, docs/, guides) AND agent/operator instruction files (CLAUDE.md, AGENTS.md, cursor/copilot rules, SKILL.md, runbooks) — for lines the diff made false, guardrails the diff deleted or contradicted, agents.md drift, and prose that grew by appending instead of replacing one line. Merges the former Fresh Docs and Fresh Runbook reviewers (2026-08-31): one docs reviewer, one diet, both file classes.

Ask for it

Review PR {number} for docs freshness

Sample Output

What a Docs Freshness report looks like.

IonWarpbotcommented 2 min ago

IonWarp Review — PR #144

3 issues| 2 P1 1 P2

#SevIssueFile

1Public API changed without docs updatedocs/api.md

2README install steps staleREADME.md

3Deleted guardrail left contradicted ruleCLAUDE.md

docs/api-reference.md

88899091

++++

### POST /v1/reviewsReturns: `{ id: string, status: "queued" | "running" }` Queues a swarm review against the given PR.

Return type undocumented for /v1/reviews · Docs Freshness

Consumers of the public API have to read source to know the return shape. Add an explicit response section.

Suggested fixAI fix prompt

Docs Freshness

Details

What a Docs Freshness report looks like.

IonWarp Review — PR #144

Return type undocumented for /v1/reviews · Docs Freshness

More agents in the swarm.