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.
Use this when
Use this whenever implementation changes may have left READMEs, setup guides, API references, examples, or runbooks behind.
How it runs
- Review implementation changes since the last documentation pass.
- Compare the repository's documentation with the code, configuration, commands, and behavior that now ship.
- Update only stale material, then verify commands, links, and examples against the current repository.
- Run the relevant checks and open a pull request that explains the documentation drift and the fixes.
Done when
✓ Documentation matches the current implementation. Finish with a reviewable pull request.
Why it works
The loop ties documentation to the implementation instead of relying on memory. Requiring a pull request creates a visible diff, a review point, and a durable record of what changed.
Implementation note
Keep the scope tied to real implementation changes. Do not rewrite accurate documentation just to create activity.
More docs loops
Close the gaps before you build
Fill documentation gaps until requirements, technical design, acceptance criteria, and test strategy describe one buildable system.
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.
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.