Did not mention the path of the index.html to be created in the docs/v4
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- javascript, node.js
- Domain
- documentation
Research direction
Start with the Socket.IO documentation page for tutorial/step-2 and read the notes around the index.html instructions. Clarify that the file belongs in the current directory, then verify the wording is unambiguous for readers following the tutorial. Done means the page explicitly states where to create index.html.
Written by the indexing model from the issue text.
Description
In https://socket.io/docs/v4/tutorial/step-2 page, in the notes it is not specify where to create the index.html file
as it may confuse lots of user who are already familiar with some server side development using NodeJS as most
of the developers placed their .html files in /public folder or may be in some other folder (usually place in folder)
It's a very small and optional issue, but still will help lots of developers.
As most of the developers
who would be learning using docs may get confuse with lots of new keyword like
import.meta.url and fileURLToPath() method and etc...
We just need to edit the description and tell users to create the index.html file in current directory only.
- 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 121 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
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
processing/p5.sound.js#123 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
PhilflowIO/dav-mcp#146 ·
Maintainers usually reply within 1 day
-
good first issue hacktoberfest
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Tanishq964/trail-kit.#4 ·
-
new icon permissions in review
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
simple-icons/simple-icons#15067 ·
Maintainers usually reply within 1 day
-
status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
mastra-ai/mastra#26562 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day