Add minimal documentation stub #40
Merged
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
Codecov Report
@@ Coverage Diff @@
## master #40 +/- ##
=======================================
Coverage 87.61% 87.61%
=======================================
Files 1 1
Lines 105 105
=======================================
Hits 92 92
Misses 13 13 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
I like the idea of transitioning to a more complete docs page. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This makes progress towards resolving #37. Of course it's not there yet, because the generated docs are missing most of the useful information in the README.md... But at least it is a start.
To make further progress, we could just copy that from the README.md to the manual, but now the same text lives in two places and needs to be kept in sync. Perhaps it would be better to move most of the text in the README.md and just retain a link to the manual plus perhaps some quick examples?
Thoughts?