oxidecomputer / oxidecomputer/oxide.rs
Include all the docs in the CLI
Open
Nobody has claimed this yet.
feature
- 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 neat to build all the contents of the docs site — API, CLI (obviously), and handwritten guides — into the CLI. It would be pretty easy and would be very handy to coding agents.
Implementation details
No response
Anything else you would like to add?
No response
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
The issue names no files or tests. Start by mapping how the CLI and docs site currently build their API docs, CLI docs, and handwritten guides; define the supported scope and integration point, then verify that all three document groups are available through the CLI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cli, rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100