socketio / socketio/socket.io-website
[Feature request]: Visual difference between server-api and client-api docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 342
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
Think it would be helpful to change the visual style of the the api docs, just to better differentiate the server from the client docs. In the current state I often find myself accidentally getting into the wrong documentation. A drastic visual difference, like a dark background on the server page and a light client-api page would solve that.
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 does not name files or tests. Start by locating the server-api and client-api documentation pages and comparing their current visual styles. Done means users can reliably distinguish which documentation they are viewing, with the chosen visual difference applied consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- design, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100