Docs Sync After Edits

After code changes, find affected docs and update README, API references, and inline comments to match.

0 views•0 uses•by solo lemon.

// parameters

Triggermanual

Max iterations10

Exit conditionAll affected documentation updated and verified against the diff

// run_this_loop

Copy the kickoff into your agent first. The blueprint below explains how the loop evaluates progress and when it should stop.

Open in Cursor Open in Claude

Use loop copies the kickoff prompt. Share copies the loop link. Open in Cursor / Claude only pre-fill that prompt — they do not install hook files. Download loop saves the loop as docs-sync-after-edits.md.

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.

// blueprint

The loop contract: target outcome, execution sequence, checks, stopping condition, and safety constraints.

Goal

documentation matches the current code changes

// loop_sequence

// loop_sequence_diagram.json

closed loop

Trigger

Manual start

Actions block

4 steps

1Identify changed areas

2Find stale docs

3Update documentation

4Verify accuracy

Feedback gate

Evaluate: state progress

Run the check, read the output, then decide whether the loop is complete.

Check failed

Repeat actions with the latest feedback.

Success

All affected documentation updated and verified against the diff

Safety capMax 10 iterations

// 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.

// related_recipes

Maintenance

Dependency Audit Weekly

Weekly loop to check outdated dependencies, propose safe upgrades, and open a summary.

#dependencies#maintenance#security

compatible with:

Maintenance

Knip Until Clean

Find and remove dead exports, unused files, and orphan dependencies — loop until knip reports clean.

#maintenance#dead-code#deps

compatible with:

Maintenance

Dependency Upgrade One-by-One

Upgrade a single outdated package per iteration, fix breakages, and commit — safer than bulk npm update.

#dependencies#maintenance#upgrades

compatible with: