← Back to catalog
LoopEngineering↓ 0

Docs Sweep Loop

Keeps documentation aligned with the current codebase and opens a reviewable pull request on every pass.

Loops are usage routines — there is no install command. See how to run it just below.

This loop keeps documentation in sync with the code as it changes.

The cycle diffs the docs against the source, finds any public API, CLI flag, or config option that changed or is undocumented, updates the smallest meaningful slice, and opens a focused PR.

It repeats until docs and code fully agree.

Instead of one giant batch, each improvement becomes a small, reviewable PR with a warning-free docs build.

When to use

  • After releases that rename flags, APIs, or configs.
  • When documentation keeps lagging behind the code.
  • To produce small, easy-to-review docs PRs.

How to use

Run the loop asking it to compare docs against code, update what drifted, and open a focused PR, continuing until docs and code match.