oxidecomputer / oxidecomputer/oxide.rs
Flesh out documention on how `json-body` works
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 75
- Forks
- 21
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
Currently we provide a few examples of using --json-body with CLI commands in https://docs.oxide.computer/cli/guides/introduction, but don't get into the details of how we expect it to be used.
We should document:
- When a value is specified as an
--<ARG>and in the JSON body, which one is used? - Which commands require it?
- Guidance on when we recommend using it.
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 the existing --json-body examples in the CLI introduction guide linked in the issue, then inspect the CLI behavior for commands that accept both argument values and a JSON body. Update the documentation to explain precedence, commands that require --json-body, and recommended usage; the guide should answer all three questions clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100