Repository navigation
docs(agents): add the post-release docs checklist - #7
Merged
Merged
Conversation
After the 0.3.0 release, the CBTC and BETH docs needed a pin update, a rewrite of the CBTC code samples, and a fix to the redemption description. Nothing in the repository told an agent that a release includes this work. AGENTS.md now lists what to check in the docs of every supported asset, and how to verify it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
PumpkinSeed
approved these changes
Oct 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What: This PR adds
AGENTS.md. The file tells an agent that a release of this crate includes an update of the public docs of every supported asset.Why: The 0.3.0 release needed docs changes for both assets: new pins, rewritten CBTC samples, and a corrected redemption description. No file in the repository said that this work belongs to a release.
How: The file gives a short list of what to check and how to verify it. It leaves the details to the agent. It names the assets through
src/tokens/, so a new asset needs no edit. It also says that the docs live in GitBook, and that the agent needs a GitBook access token from the pilot.Tests: None needed. The change adds documentation only.
🤖 Generated with Claude Code