oxidecomputer / oxidecomputer/omicron
docs: Document what "distro"/"version" are meant to be used for
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
I think it's unclear to a user importing an image why they need to specify a distro and version. Does the rack use this metadata? Is it strictly for the sake of users?
Contributor guide
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
No file or test is named. Start by locating the image import documentation and the code or API entry point that handles distro and version metadata, then trace whether the rack consumes those fields or they are user-facing only. Done means the documentation clearly explains the purpose of both values.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100