Keep docs in sync with main
On every push to main, check whether changed code drifted from the docs in /docs and open a PR fixing anything out of date.
/schedule on every push to main, check whether the changed code drifted from the docs in /docs, and open a PR fixing anything out of date
claude-code · codex
Implementation note
Because it opens PRs rather than pushing directly, a human always reviews the doc changes. Fires on every push, so cost scales with commit volume.
More docs loops
Changelog generation from commits
Turn the commit history since the last release tag into a human-readable, categorized CHANGELOG entry ready for the next version.
/goal CHANGELOG.md has a complete entry for the next release — read every commit since the last version tag, group changes into Added, Changed, Fixed, and Removed, write user-facing descriptions (not commit messages), link PR numbers, and flag anything that looks like a breaking change; stop after 5 turns
docslow risk
Close the gaps before you build
Fill documentation gaps until requirements, technical design, acceptance criteria, and test strategy describe one buildable system.
Prepare [project] for implementation. Ensure its documents cover requirements, technical design, tasks with acceptance criteria, and test strategy. Each round, fix the largest gap or contradiction that could make two competent engineers build different systems. Keep details traceable, record assumptions, and ask before product forks. Recheck consistency, then have two independent reviewers describe the components, data model, dependencies, and definition of done. Stop when they materially agree and every artifact is testable, or a decision needs the user.
docslow risk
Fix doc drift, ship a PR
Compare every doc against the current code, fix what's stale, verify commands and links, and open a reviewable PR.
Whenever a documentation pass is needed, review the codebase in full and make sure all documentation reflects the current implementation. Update stale documentation, verify the changes, then open a pull request.
docslow risk