This repository has been archived by the owner on Mar 11, 2019. It is now read-only.
Change documentation to make it straight forward #95 #108
Conversation
This file contains 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
re-structure the documentation so that it flows from use case, setup and usage.
Codecov Report
@@ Coverage Diff @@
## master #108 +/- ##
=======================================
Coverage 91.84% 91.84%
=======================================
Files 34 34
Lines 1116 1116
=======================================
Hits 1025 1025
Misses 91 91
Continue to review full report at Codecov.
|
|
Hey @musale thanks for this pull request. |
|
Hi @mwaaas! I have done the merge |
Repository owner
deleted a comment
Sep 18, 2017
Repository owner
deleted a comment
Sep 18, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Re-structure the documentation so that it flows from use case, setup and usage.
Description
The current documentation lacks a straightforward flow and presentation. This attempts to address the issue making it easier to navigate the documentation.
Reference to official issue
Covers raised issue #95. Even though much hasn't been explained in the issue, this PR attempts to address the basic documentation issues.
Motivation and Context
This will improve user documentation for the library
How Has This Been Tested?
Locally after running
docker-compose up, navigate to http://localhost:7000/