Docs Sync After Edits
A documentation maintenance loop that prevents code and docs from drifting after agent edits.
Use loop copies the kickoff prompt. Copy Markdown and Download loop include the complete Markdown page with context, source attribution, anchors, and guardrails. Cursor / Claude Code buttons prepare the shorter kickoff prompt only.
Supported agents
Goal
Keep documentation aligned with code changes.
Feedback gate
git diff --name-only HEADStop condition
Docs are updated for relevant changes or the no-docs-needed decision is justified.
Give the agent these inputs before it starts the loop. This keeps discovery bounded and prevents vague retries.
The loop assumes these commands or integrations are available. Missing tools should be reported as blockers, not ignored.
Two separate pieces: the kickoff prompt starts the loop, while the downloaded Markdown carries the complete reference page.
1. Copy or download
Use the kickoff for a fast agent run. Download the full Markdown when you need source, context, and attribution in one file.
2. Paste into the agent
Start a fresh agent session in the target repo and provide the requested project context if the loop asks for it.
3. Let it self-pace
The agent should act, check evidence, retry only when the gate fails, and stop at the stated exit condition.
The diagram shows the order. This checklist keeps only the action, command, and failure handling needed during a real pass.
1. Inspect changed files
Find behavior, env, API, route, or command changes.
git diff --name-only HEAD2. Find affected docs
Search README, docs, examples, and agent instructions.
3. Patch docs
Update examples and instructions with current behavior.
4. Verify links/commands
Check changed docs for broken commands or stale references.
This is the text copied by Use loop. It is intentionally shorter than the Markdown export.
Review code changes for documentation impact, update relevant docs/examples/instructions, and report evidence or why no docs update is needed.
Goal: Keep documentation aligned with code changes.
Check command: git diff --name-only HEAD
Exit condition: Docs are updated for relevant changes or the no-docs-needed decision is justified.
Max iterations: 3
Guardrails:
- Do not weaken, skip, delete, or rewrite the validation command to force success.
- Do not claim completion until the stated exit condition is actually satisfied.
- If blocked, report the blocker, evidence, and next safest action instead of gaming the metric.
- Do not update docs with behavior that the code does not actually implement.Quality
86/100
Safety
92/100
Expected output
Updated docs or a no-docs-needed justification.
Related loops
Browse allAGENTS.md Improvement Loop
Audit and improve repository agent instructions so future AI sessions follow project conventions and verification rules.
Kickoff preview
Audit repository agent instructions against actual project files, then improve them with accurate commands, architecture rules, and verification expectations. Goal: Make repository instructions accurate, actionable, and verification-oriented. Check command: ls -la && rg -n "build|test|lint|deploy" README.md package.json AGENTS.md CLAUDE.md Exit condition: Agent instructions state stack, commands, architecture rules, and verification expectations accurately. Max iterations: 3 Guardrails: - Do not weaken, skip, delete, or rewrite the validation command to force success. - Do not claim completion until the stated exit condition is actually satisfied. - If blocked, report the blocker, evidence, and next safest action instead of gaming the metric. - Do not invent commands, tools, or architecture claims that are not present in the repository.
PR Self Review
Have the agent review its own pull request for requirement coverage, risky changes, and missing tests.
Kickoff preview
Review your own PR against the original task, changed files, tests, and risk categories. Fix must-fix issues and report evidence. Goal: Identify problems in the agent’s own PR before human review. Check command: git diff --stat main...HEAD && git diff --check main...HEAD Exit condition: No must-fix review issues remain, or unresolved issues are clearly documented. Max iterations: 3 Guardrails: - Do not weaken, skip, delete, or rewrite the validation command to force success. - Do not claim completion until the stated exit condition is actually satisfied. - If blocked, report the blocker, evidence, and next safest action instead of gaming the metric. - Do not hide unresolved issues; label them as risks or blockers.
Regression Risk Audit
Map a change to likely regressions, then run or propose focused checks for those risks.
Kickoff preview
Map the changed files to affected call chains, list likely regressions, verify the top risks, and report remaining uncertainty. Goal: Identify likely regressions and verify the highest-risk paths. Check command: git diff --name-only main...HEAD Exit condition: Top regression risks are either tested, ruled out, or documented as unresolved. Max iterations: 4 Guardrails: - Do not weaken, skip, delete, or rewrite the validation command to force success. - Do not claim completion until the stated exit condition is actually satisfied. - If blocked, report the blocker, evidence, and next safest action instead of gaming the metric. - Do not overstate confidence when a risk was not actually verified.
Ship PR Until Green
Implement a scoped change, open or update a pull request, inspect CI, and continue until all required PR checks pass.
Kickoff preview
Take this branch to a green pull request. Implement the requested change, run local verification, open or update the PR, run `gh pr checks`, inspect failures, fix root causes, and repeat until every required check passes or you hit the iteration cap. Goal: Open or update a pull request and stop only when all required PR checks are green. Check command: gh pr checks Exit condition: All required pull request checks are successful and the PR is ready for review or merge. Max iterations: 10 Guardrails: - Do not weaken, skip, delete, or rewrite the validation command to force success. - Do not claim completion until the stated exit condition is actually satisfied. - If blocked, report the blocker, evidence, and next safest action instead of gaming the metric. - Do not disable required checks, edit loops to skip jobs, or remove tests to make CI green. - Do not merge the PR unless the user explicitly asked for merge authority.