The docs sweep

# The docs sweep

## Purpose

A reusable AI coding-agent workflow for comparing documentation with the current codebase, fixing drift, and opening a reviewable pull request.

## Prompt

```text
Whenever a documentation pass is needed, review the codebase in full and make sure all documentation reflects the current implementation. Update stale documentation, verify the changes, then open a pull request.
```

## When To Use

Use this whenever implementation changes may have left READMEs, setup guides, API references, examples, or runbooks behind.

## Workflow

- Review implementation changes since the last documentation pass.
- Compare the repository's documentation with the code, configuration, commands, and behavior that now ship.
- Update only stale material, then verify commands, links, and examples against the current repository.
- Run the relevant checks and open a pull request that explains the documentation drift and the fixes.

## Verifier

Documentation matches the current implementation.

Finish with a reviewable pull request.

## Notes

The loop ties documentation to the implementation instead of relying on memory. Requiring a pull request creates a visible diff, a review point, and a durable record of what changed.

Keep the scope tied to real implementation changes. Do not rewrite accurate documentation just to create activity.

## Source

- Source: Forward Future Loop Library
- Author: Matthew Berman
- Published: 2026-06-12
- Modified: 2026-06-18
- URL: https://signals.forwardfuture.ai/loop-library/loops/overnight-docs-sweep/