diff --git a/AGENTS.md b/AGENTS.md index 7f7dfca..546360d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -258,10 +258,28 @@ Only the project maintainer bumps submodule refs. When bumped: **General checklist (all submodules):** 1. Identify changes: `git -C .sources/ log --oneline ..` -2. Grep docs pages for content derived from that submodule; update affected pages +2. Apply any mechanical per-submodule steps (synced file copies, link slug updates — see table below) 3. Check open PRs — post a comment if the bump may affect pages under review (format below) 4. **For release-pinned repos:** update `.sources/VERSIONS` 5. Note the bump in the PR description +6. **Always open a follow-up GitHub issue** for a dedicated docs review (label: `documentation`, title: `docs: review docs after bumping to `). Include the old and new version, a summary of what changed (from the changelog/log), and the instruction below for the reviewing agent. + +**Follow-up issue body template:** +``` +`` was bumped from `` to ``. + +## What changed + + +## Docs review task +Review all docs pages that reference content from this submodule (API names, CLI commands, canister IDs, code patterns, version numbers). For every affected page, check it against the new version and update as needed. Look for: +- Changed or removed APIs/commands that appear in code blocks or prose +- New APIs not yet documented +- Cross-SDK gaps (e.g. a new API landed in one language but not others) +- Version numbers that need updating + +Submodule source: `.sources//` +``` **PR comment format:** ```bash