Skip to content

Require release documentation sweep #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Maples7 merged 1 commit into from
May 14, 2026
Merged

Require release documentation sweep #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,15 @@ because past sessions repeatedly rediscovered them the hard way.
first place. New code in `vch/` should be a few lines that call
into Core; if a `Commands/*.swift` file grows a decision tree,
the decision tree belongs in `Logic/` or `Services/`.
8. **Release docs sweep.** Every release PR must explicitly check
whether the official Agent runbook (`docs/agent-runbook.md`),
README family (`README.md` plus localized READMEs when the
README sync rule applies), command reference (`docs/commands.md`),
cookbook, and any other user-facing documentation need updates for
the release contents. Update stale docs in the release PR, or state
in the PR body that the docs were reviewed and no changes were
needed. Do not push a release tag when user-facing docs describe a
different CLI than the version being released.

## Architecture map

Expand Down