oxidecomputer / oxidecomputer/oxide.rs
Distinguish meta CLI commands like `version` and `completion` in docs site
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 75
- Forks
- 21
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
Target component
- CLI
- SDK
- Something else
- Not sure
Overview
It would be nice to put information in the CLI docs JSON to allow the docs site to distinguish between commands like completion and version (possibly auth? meh, nah) and the rest, which have to do with actual API resources.
Implementation details
Two ideas:
- Give tags to top-level CLI commands to allow grouping in docs site sidebar, like we do with the API endpoints. In the API, endpoints with a tag starting with
system/get grouped underSystemand the rest go underDeveloper. - Don't do formal grouping or tagging, but put
completionsandversionunder a top-leveloxide selfcommand so they at least take up less space and it's easier to tell they don't have anything to do with the API itself.
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 CLI docs JSON and the docs site sidebar, then inspect how API endpoint tags are currently grouped, including the system/ convention. Compare the two proposed approaches for distinguishing completion, version, and possibly auth; done means the chosen organization is represented consistently in the CLI documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100