socketio / socketio/socket.io-website

Did not mention the path of the index.html to be created in the docs/v4

Open
#483 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
342
Forks
1.1k
PR merge metrics
No merged PRs in 30d

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)

Image

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.