Re-work Docs and split out README (using MkDocs) #2894
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 ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## master #2894 +/- ##
==========================================
- Coverage 36.29% 36.22% -0.08%
==========================================
Files 60 60
Lines 2849 2849
Branches 471 471
==========================================
- Hits 1034 1032 -2
- Misses 1753 1755 +2
Partials 62 62 see 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
ntindle
previously requested changes
Apr 22, 2023
ntindle
reviewed
Apr 22, 2023
ntindle
reviewed
Apr 22, 2023
ntindle
reviewed
Apr 22, 2023
ntindle
reviewed
Apr 22, 2023
Pwuts
reviewed
Apr 22, 2023
Pwuts
reviewed
Apr 22, 2023
Pwuts
reviewed
Apr 22, 2023
Co-authored-by: Reinier van der Leer <[email protected]>
Torantulino
reviewed
Apr 22, 2023
Torantulino
previously requested changes
Apr 22, 2023
Pwuts
reviewed
Apr 22, 2023
p-i-
approved these changes
Apr 22, 2023
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.
Background
The README is too long, and difficult to read/maintain. Split into separate markdown files in the /docs folder. Set up mkdocs to host a static site on github pages.
Changes
Documentation
Test Plan
PR Quality Checklist