Add better docs for new options system
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 161
- Forks
- 16
- Avg merge
- 3h 21m
- Merged PRs (30d)
- 5
Description
We don't have much in the way of docs covering the new option system. There are many things in https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit/opts.rb that should probably be covered, e.g.
- option
- multi_option
- position
- rest
- skippable positions
- callable defaults
- ...
Additionally, it would be good to include useful patterns such the --no-<multi_option> flag to zero a multi_option default described in https://github.com/Shopify/cli-kit/pull/246
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with lib/cli/kit/opts.rb to understand option, multi_option, position, rest, skippable positions, and callable defaults. Read pull request #246 for the --no-<multi_option> pattern. Done means the new option system and useful patterns are documented, including the listed behaviors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100