HTTP API Docs missing information & incompatible with Docs dark theme
Open
Nobody has claimed this yet.
Document
Feedback
- Dominant language
- Go
- Stars
- 361
- Forks
- 159
- PR merge metrics
- No merged PRs in 30d
Description
Context: https://discord.com/channels/613813861610684416/1047080826573172746/1047080826573172746
-
Documentation should be updated to explain available flags like
height=sealedandheight=final. Currently they are hidden behind a dropdown and are not explained. -
Minor note: Dark theme breaks API spec since text turns white and is not visible anymore.
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 with the HTTP API documentation and the embedded API spec shown in the issue screenshots. Verify that height=sealed and height=final are explained, then check the documentation in the dark theme; done means the flags are visible and the API text remains readable.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100