Docs Sync After Edits
After code changes, find affected docs and update README, API references, and inline comments to match.
Kickoff prompt
Start the "Docs Sync After Edits" loop.
Goal: documentation matches the current code changes
Max iterations: 3
Between iterations run: git diff main...HEAD --name-only
Exit when: all affected docs are updated and verified
Step 1: Review the diff, find stale docs, update them, and verify accuracy.
Self-pace this loop. After each iteration, run the check command, read the output, and only continue if the exit condition is not met. Stop when the exit condition passes or max iterations is reached. Give a short status update each pass.Basic information
Category
Maintenance
Goal
documentation matches the current code changes
Max iterations
3
Check command
git diff main...HEAD --name-only
Exit when
all affected docs are updated and verified
Supported agents
Cursor
Steps
- 1
Identify changed areas
Review the current diff. List public APIs, config options, and behaviors that changed.
- 2
Find stale docs
Search README, docs/, and code comments for references to changed behavior. Flag outdated sections.
- 3
Update documentation
Update docs to match the code. Keep examples runnable and accurate. Remove obsolete sections.
- 4
Verify accuracy
Re-read updated docs against the diff. Confirm no contradictions remain.
More Maintenance loops
Dependency Upgrade One-by-One
Upgrade a single outdated package per iteration, fix breakages, and commit — safer than bulk npm update.
Knip Until Clean
Find and remove dead exports, unused files, and orphan dependencies — loop until knip reports clean.
Dependency Audit Weekly
Weekly loop to check outdated dependencies, propose safe upgrades, and open a summary.
Security Audit Weekly
Weekly npm audit scan, triage vulnerabilities by severity, and propose or apply safe patches.