[Feature request]: Visual difference between server-api and client-api docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- design, documentation
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.
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.
- Dominant language
- JavaScript
- Stars
- 342
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from socketio/socket.io-website
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
socketio/socket.io-website#475 · 1 comment ·
-
The Replit and CodeSandbox interactive example links featured on the homepage under the "Basic example" section are currently broken and returning error pages.Possibly taken @Hashim1999164 claimed this 6 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 72/100
socketio/socket.io-website#551 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
socketio/socket.io-website#550 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
socketio/socket.io-website#539 · 7 comments ·
-
Step #7 Server delivery has multiple issuesPossibly taken @vipin8797 claimed this 122 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 38/100
socketio/socket.io-website#512 ·
All issues in socketio/socket.io-website
Similar issues
-
bug user-priority/P2
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
bug confirmed perf
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
videojs/video.js#9400 · 1 comment ·
Maintainers usually reply within 1 day
-
agent/scanner bug hive/hosted-available-lke648397-260827-5n31
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
rescript-lang/rescript#8765 ·
Maintainers usually reply within 1 day
-
feedback simulation workshop
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
githubnext/gh-aw-workshop#4417 ·
Maintainers usually reply within 1 day