Skip to content

feat: add examples to --help output for complex commands#154

Merged
angeloashmore merged 5 commits intomainfrom
feat/help-examples
Apr 18, 2026
Merged

feat: add examples to --help output for complex commands#154
angeloashmore merged 5 commits intomainfrom
feat/help-examples

Conversation

@angeloashmore
Copy link
Copy Markdown
Member

@angeloashmore angeloashmore commented Apr 18, 2026

Resolves: #148

Description

Adds EXAMPLES sections to --help output for commands with non-obvious flag combinations: field add rich-text, field add content-relationship, field add select, type create, and slice connect.

Checklist

  • A comprehensive Linear ticket, providing sufficient context and details to facilitate the review of the PR, is linked to the PR.
  • If my changes require tests, I added them.
  • If my changes affect backward compatibility, it has been discussed.
  • If my changes require an update to the CONTRIBUTING.md guide, I updated it.

Preview

How to QA 1

Run --help for each modified command and verify the EXAMPLES section appears:

  • prismic field add rich-text --help
  • prismic field add content-relationship --help
  • prismic field add select --help
  • prismic type create --help
  • prismic slice connect --help

Note

Low Risk
Low risk: changes only add EXAMPLES text blocks to --help output and do not modify command execution logic.

Overview
Improves CLI discoverability by adding EXAMPLES sections to --help output 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, and webhook 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

  1. Please use these labels when submitting a review:
    ❓ #ask: Ask a question.
    💡 #idea: Suggest an idea.
    ⚠️ #issue: Strongly suggest a change.
    🎉 #nice: Share a compliment.

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>
Copy link
Copy Markdown
Member Author

@angeloashmore angeloashmore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/commands/field-add-content-relationship.ts Outdated
Comment thread src/commands/field-add-rich-text.ts Outdated
Comment thread src/commands/field-add-select.ts Outdated
Comment thread src/commands/field-add-select.ts Outdated
angeloashmore and others added 2 commits April 18, 2026 01:36
- 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>
Comment thread src/commands/token-create.ts Outdated
angeloashmore and others added 2 commits April 18, 2026 01:57
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>
@angeloashmore angeloashmore merged commit a4e39db into main Apr 18, 2026
22 of 23 checks passed
@angeloashmore angeloashmore deleted the feat/help-examples branch April 18, 2026 03:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: add examples to --help output

1 participant