Skip to content

infra: always open follow-up issue after submodule bumps for docs review #206

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

Open
marc0olo wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Open

infra: always open follow-up issue after submodule bumps for docs review #206

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
20 changes: 19 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,10 +258,28 @@ Only the project maintainer bumps submodule refs. When bumped:

**General checklist (all submodules):**
1. Identify changes: `git -C .sources/<repo> log --oneline <old-ref>..<new-ref>`
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 <submodule> to <new-ref>`). 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:**
```
`<submodule>` was bumped from `<old-ref>` to `<new-ref>`.

## What changed
<paste relevant entries from git log / CHANGELOG>

## 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/<submodule>/`
```

**PR comment format:**
```bash
Expand Down
Loading