oxidecomputer / oxidecomputer/oxide.rs
`about` duplicated in `long_about`
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 75
- Forks
- 21
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
I think this is only happening with commands in this repo. See oxide.rs/cmd_disk.rs -> oxide.rs/cli.json.
Expecting that the first paragraph is used for about and the rest for long_about.
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 linked command definition in cli/src/cmd_disk.rs and compare its generated entry in cli/docs/cli.json. Check how the command description is split between about and long_about; done means the first paragraph appears only in about and the remaining text appears in long_about.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100