-
Notifications
You must be signed in to change notification settings - Fork 34
Create Readable Documentation #39
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
Conversation
hillmich
commented
Feb 24, 2022
- Streamline README.md
- Put elaborate documentation on ReadTheDocs
- Old version in docs/ as reference when creating RtD
Codecov Report
@@ Coverage Diff @@
## master #39 +/- ##
========================================
- Coverage 88.5% 88.5% -0.1%
========================================
Files 20 20
Lines 2389 2389
========================================
- Hits 2116 2115 -1
- Misses 273 274 +1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As expected, the most critical comments are targeting the README.
The other stuff should be easy to incorporate.