Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation revamp #1948

Closed
rauchg opened this issue Jan 19, 2015 · 5 comments
Closed

Documentation revamp #1948

rauchg opened this issue Jan 19, 2015 · 5 comments
Milestone

Comments

@rauchg
Copy link
Contributor

rauchg commented Jan 19, 2015

  • Complete README.md API spec (like engine.io) for both socket.io and socket.io-client
  • Permalink pages for method / properties on website
@rauchg rauchg added this to the 1.4.0 milestone Jan 19, 2015
@rauchg
Copy link
Contributor Author

rauchg commented Jan 21, 2015

Also update http://devdocs.io/socketio/

@axelpale
Copy link

Possible duplicate: #2020

+1 on documentation improvement. Major issue for Socket.io growth. For example in some cases, precious info can be found from github.com/Automattic/socket.io. In some others, from socket.io/docs/ only, such as volatile messages. Furthermore, as pointed out also by previous comments, docs are still insufficient and the behavior has to be digged out elsewhere, like is the situation with socket.connection.

@jamlfy
Copy link

jamlfy commented Jun 18, 2015

+1 I like! We need a manual.

@jhohlfeld
Copy link

Yes please!

plz remember mentioning connecting to a namespace needs the fully qualified url when using a non-standard port on the client:
http://stackoverflow.com/questions/32363060/socketio-namespace-client-connection-refused/34352508#34352508

And the interface of Socket is also incomplete. Had to dig out Socket.disconnect from src code.

@rauchg
Copy link
Contributor Author

rauchg commented Dec 18, 2015

We're working on this @jhohlfeld. Thanks for taking the time to leave the feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants
@rauchg @jhohlfeld @axelpale @jamlfy @darrachequesne and others