create an mdbook for documentation #427
Merged
Conversation
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
Start to resolve #62 and other documentation related issues.
Codecov Report
@@ Coverage Diff @@
## master #427 +/- ##
======================================
Coverage 43.7% 43.7%
======================================
Files 136 136
Lines 59536 59536
======================================
Hits 26019 26019
Misses 33517 33517Continue to review full report at Codecov.
|
ghost
mentioned this pull request
|
Thank you for the submission, and sorry for the delay in my getting to this! Let's get things rolling! |
|
No need to apologize @pkgw! 🚀 |
ghost
deleted the
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.
Start to resolve #62 and other documentation related issues.
I found this this rust subreddit discussion about best practices for documentation. Doxidize seems like it could suit us well but isn't ready for use.
mdBook may not integrate as nicely with a crate but it seems like the community standard.
I started a preliminary structure but am sure we should establish the audience and then establish a suitable TOC.