Added github pages documentation#2
Merged
trinopoty merged 8 commits intosocketio:masterfrom Aug 10, 2018
Merged
Conversation
Added documentation theme
Added usage docs
Codecov Report
@@ Coverage Diff @@
## master #2 +/- ##
=======================================
Coverage 82.59% 82.59%
=======================================
Files 10 10
Lines 540 540
Branches 79 79
=======================================
Hits 446 446
Misses 61 61
Partials 33 33 |
docs/index.rst
Outdated
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
|
|
||
| Welcome to Engine.IO's documentation! |
Member
There was a problem hiding this comment.
Maybe "Java implementation" should be inserted somewhere, to clarify.
docs/using.rst
Outdated
| @@ -0,0 +1,89 @@ | |||
| ===== | |||
| Using | |||
Member
There was a problem hiding this comment.
How about "Getting started"?
Collaborator
Author
There was a problem hiding this comment.
"Using" to "Getting Started"?
trinopoty
force-pushed
the
documentation
branch
from
0c66195 to
f72b07e
Compare
darrachequesne
approved these changes
Aug 9, 2018
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
View documentation at https://socketio.github.io/engine.io-server-java/.
This adds much more documentation of the API and usage than README.