Update install docs for v3, slim build missing
Open
Nobody has claimed this yet.
documentation
package:socket.io-client
- Dominant language
- TypeScript
- Stars
- 63.2k
- Forks
- 10.3k
- Avg merge
- 11d 20h
- Merged PRs (30d)
- 2
Description
The install docs have not been updated for v3. There is no slim build anymore, is it on purpose?
If so, which bundle do you recommend for development and which one for production? Or there isn't any differentiation anymore?
Before I had this in webpack aliases:
let socketioClient
if (process.env.NODE_ENV === 'development') {
socketioClient = 'socket.io-client/dist/socket.io.dev.js'
} else {
socketioClient = 'socket.io-client/dist/socket.io.slim.js'
}
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
Locate the installation documentation and the v3 client bundle references, then compare them with the current package contents and the webpack alias example in the issue. Confirm the development and production guidance with maintainers, and consider the work done when the docs accurately explain the available bundles and whether any differentiation remains.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, webpack
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100