oxidecomputer / oxidecomputer/omicron
`external_docs` link in `external_api/tag-config.json` 404s
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 572
- Forks
- 97
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 96
Description
We link to top-level API endpoint pages that don't exist:
https://github.com/oxidecomputer/omicron/blob/bca1f2d63b70e71aef509b94e190e54c6eb3a6be/nexus/src/external_api/tag-config.json
For example: "url": "http://docs.oxide.computer/api/disks"
I do want to add top-level pages to the docs site, but we could probably remove for now. Where are these links visible? Do they appear in the type comments?
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
Start by reading nexus/src/external_api/tag-config.json and tracing where its external_docs links are exposed, including the type comments or documentation site. Confirm which top-level endpoint links 404, then remove or update the broken entries and verify that the resulting documentation links resolve.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100