question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation revamp

See original GitHub issue
  • Complete README.md API spec (like engine.io) for both socket.io and socket.io-client
  • Permalink pages for method / properties on website

Issue Analytics

  • State:closed
  • Created 9 years ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
rauchgcommented, Dec 18, 2015

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

1reaction
axelpalecommented, Jun 18, 2015

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Documentation revamp: status and future plans
Documentation revamp : status and future plans · Official documentation: · Official books and third party books · Community wiki: wiki.liferay.com · Javadocs...
Read more >
Technical Documentation Revamp - Zai User Guides
Technical Documentation Revamp · New API reference specifications · New material in our guides section.
Read more >
Revamp Your Company Procedures with Document Control
These could include supporting documents, procedures, records, forms, manuals, work instructions, job aids, job descriptions or compliance ...
Read more >
The Great Documentation Revamp - AppGyver
In this blog post, we'll explore the most important changes. New Structure. The documentation has been completely restructured. It is now utilizing the...
Read more >
Documentation Revamp - GitHub
Open source simulator for autonomous vehicles built on Unreal Engine / Unity, from Microsoft AI & Research - Documentation Revamp ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found