feat: add examples to --help output for complex commands#154
Merged
angeloashmore merged 5 commits intomainfrom Apr 18, 2026
Merged
feat: add examples to --help output for complex commands#154angeloashmore merged 5 commits intomainfrom
angeloashmore merged 5 commits intomainfrom
Conversation
Adds EXAMPLES sections to field add rich-text, field add content-relationship, field add select, type create, and slice connect. Resolves #148 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
angeloashmore
commented
Apr 18, 2026
Member
Author
angeloashmore
left a comment
There was a problem hiding this comment.
Let's include examples in more commands. Think about what commands will be most commonly used AND are complex. We need to provide examples for those commands.
- Use "Allow any document" instead of "Relate to any document" - Simplify rich-text --allow list - Use marketing-site examples for select field Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
angeloashmore
commented
Apr 18, 2026
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.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
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.
Resolves: #148
Description
Adds EXAMPLES sections to
--helpoutput for commands with non-obvious flag combinations:field add rich-text,field add content-relationship,field add select,type create, andslice connect.Checklist
Preview
How to QA 1
Run
--helpfor each modified command and verify the EXAMPLES section appears:prismic field add rich-text --helpprismic field add content-relationship --helpprismic field add select --helpprismic type create --helpprismic slice connect --helpNote
Low Risk
Low risk: changes only add
EXAMPLEStext blocks to--helpoutput and do not modify command execution logic.Overview
Improves CLI discoverability by adding
EXAMPLESsections to--helpoutput for several commands with non-obvious flag combinations.Examples were added to
field add content-relationship,field add link,field add rich-text,field add select,field edit,slice connect,type create, andwebhook create, without changing runtime behavior.Reviewed by Cursor Bugbot for commit 15fc6fd. Bugbot is set up for automated code reviews on this repo. Configure here.
Footnotes
Please use these labels when submitting a review:
⚠️ #issue: Strongly suggest a change.
❓ #ask: Ask a question.
💡 #idea: Suggest an idea.
🎉 #nice: Share a compliment. ↩