Automated doc descriptions for commands#7735
Open
johndcollett wants to merge 2 commits into
Open
Conversation
github-actions
Bot
added
the
no-changelog
laurelthorburn
approved these changes
Jun 5, 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
2 participants
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.
WHY are these changes introduced?
Allows descriptions for commands to be automatically updated from the source so they don't need to be maintained in MDX files.
There will be a corresponding PR in shopify-dev to support this on our side.
WHAT is this pull request doing?
compiles a list of descriptions for each command
running the command removed some old .doc.ts files (obsolete now) and some example files (not sure if thats desired)
How to test your changes?
run the docs command and see that the command descriptions show up in cli-descriptions.json