Generated README.md using mdoc #516
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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #516 +/- ##
==========================================
+ Coverage 72.37% 72.39% +0.02%
==========================================
Files 32 32
Lines 4340 4340
Branches 927 927
==========================================
+ Hits 3141 3142 +1
+ Misses 1199 1198 -1 ☔ View full report in Codecov by Sentry. |
milessabin
force-pushed
the
topic/mdoc-readme
branch
from
0c99f40
to
9163198
Compare
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.
The repo top-level
README.mdis now generated fromdocs/index.mdandheader.mdusing mdoc by manually runningrepoDocs/mdoc. In addition the repo top-levelCONTRIBUTING.mdfile is now a symlink todocs/CONTRIBUTING.md. This means that thedocsdirectory is now the source of truth for both the tutorial and the repo as viewed in github.