Nightly Docs Sweep
Goal
Make repository documentation match the current implementation, then leave a reviewable change set or pull request.
Loop Prompt
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.
Stop when documentation matches the current implementation and the docs changes are ready for review.
When To Use
Use this whenever implementation changes may have left READMEs, setup guides, API references, examples, architecture notes, comments, 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 currently ship.
- Update only stale or missing material. Do not rewrite accurate documentation just to create activity.
- Verify commands, links, examples, configuration names, API shapes, and setup steps against the current repository.
- Run the relevant checks available in the project, such as documentation tests, link checks, type checks, unit tests, or linting.
- Summarize the documentation drift found, the files changed, and the verification performed.
- If the user asked for a PR and the environment supports it, open a pull request with a clear title and body.
Report
End with:
- Documentation areas checked.
- Stale or missing docs found.
- Files updated.
- Verification commands run and their results.
- Remaining gaps or blockers.
- Pull request link, if one was opened.
Guardrails
- Keep scope tied to real implementation behavior.
- Preserve accurate documentation and user-authored wording where practical.
- Do not invent behavior that is not backed by code, configuration, tests, or project docs.
- If the repository is too large for a full sweep in one pass, prioritize changed or high-traffic docs first and clearly state the remaining scope.
1---2name: nightly-docs-sweep3description: Run a documentation sweep so repo docs match the current implementation.4---56# Nightly Docs Sweep78## Goal910Make repository documentation match the current implementation, then leave a reviewable change set or pull request.1112## Loop Prompt1314```text15Whenever 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.16```1718Stop when documentation matches the current implementation and the docs changes are ready for review.1920## When To Use2122Use this whenever implementation changes may have left READMEs, setup guides, API references, examples, architecture notes, comments, or runbooks behind.2324## Workflow25261. Review implementation changes since the last documentation pass.272. Compare the repository's documentation with the code, configuration, commands, and behavior that currently ship.283. Update only stale or missing material. Do not rewrite accurate documentation just to create activity.294. Verify commands, links, examples, configuration names, API shapes, and setup steps against the current repository.305. Run the relevant checks available in the project, such as documentation tests, link checks, type checks, unit tests, or linting.316. Summarize the documentation drift found, the files changed, and the verification performed.327. If the user asked for a PR and the environment supports it, open a pull request with a clear title and body.3334## Report3536End with:3738- Documentation areas checked.39- Stale or missing docs found.40- Files updated.41- Verification commands run and their results.42- Remaining gaps or blockers.43- Pull request link, if one was opened.4445## Guardrails4647- Keep scope tied to real implementation behavior.48- Preserve accurate documentation and user-authored wording where practical.49- Do not invent behavior that is not backed by code, configuration, tests, or project docs.50- If the repository is too large for a full sweep in one pass, prioritize changed or high-traffic docs first and clearly state the remaining scope.
leek