AAWEA.ORG
AAWEA.ORG
AAWEA.ORG
Maintenance Manual trigger πŸ‘‘ Official

Docs Sync After Edits

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

πŸ‘ 1,454 views πŸ“₯ 1,162 installs πŸ‘€ by loops!
Download loop
Share Now
Manual start
↓
  1. 1
    Identify changed areas

    Review the current diff. List public APIs, config options, and behaviors that changed.

  2. 2
    Find stale docs

    Search README, docs/, and code comments for references to changed behavior. Flag outdated sections.

  3. 3
    Update documentation

    Update docs to match the code. Keep examples runnable and accurate. Remove obsolete sections.

  4. 4
    Verify accuracy

    Re-read updated docs against the diff. Confirm no contradictions remain.

↓
βœ“
Exit condition: manual

All affected documentation updated and verified against the diff

πŸ“Š Flow Diagram
flowchart TD Start(["Manual start"]) Start --> S0 S0("Identify changed areas") S1("Find stale docs") S0 --> S1 S2("Update documentation") S1 --> S2 S3("Verify accuracy") S2 --> S3 Exit{"All affected documentation updated and verified against the diff"} S3 --> Exit Exit -- "No" --> S0 Exit -- "Yes" --> Done(["Success"]) style Exit fill:#fffbeb,stroke:#f59e0b,stroke-width:2px,color:#92400e style Done fill:#ecfdf5,stroke:#10b981,stroke-width:2px,color:#065f46
Run "Docs Sync After Edits" in your agent
Prompt only
Deeplinks and "Open in Cursor" only paste the kickoff prompt. They do not install hook files β€” your agent cannot tell whether files are on disk until you add them yourself.
Two separate pieces
  • Kickoff prompt β€” tells the agent the goal, check command, exit condition, and how to self-pace.
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.