Add migration guides to docs command#1061
Merged
Merged
Conversation
Embed docs/v1-v2.md and docs/v2-v3.md as articles in the docs command, selectable via --article v1-v2 / v2-v3. Update the agent skill to instruct reading the migration guide before major version upgrades. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: fujiwara <fujiwara.shunichiro@gmail.com>
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
1 participant
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
docs/v1-v2.mdanddocs/v2-v3.mdas articles in thedocscommand, selectable via--article v1-v2/--article v2-v3(also listed in--list).ecspresso docs --article <from>-<to>before major version upgrades.Why
Migration guides were only available in the repository. Embedding them in the binary lets users and LLM agents look up breaking changes (e.g. v2 to v3) directly with
ecspresso docs, without AWS credentials or network access.🤖 Generated with Claude Code