docs: Move README to /docs #871
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
Codecov Report
@@ Coverage Diff @@
## main #871 +/- ##
==========================================
+ Coverage 65.65% 65.89% +0.23%
==========================================
Files 203 203
Lines 13226 13226
Branches 86 86
==========================================
+ Hits 8684 8715 +31
+ Misses 3645 3622 -23
+ Partials 897 889 -8
Continue to review full report at Codecov.
|
|
Could we remove the |
Sure! (P.S. in the future, feel free to edit titles if you see a better fit - I don't mind and I trust ya!) |
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 moves the
README.mdto a new top-level folder called/docs. We plan to add more Markdown files so this will prevent us from "polluting" the top-level space with doc files.Will this still show on the GitHub homepage?
Yup!
Source
This is how we do it in
code-serveras well.Fixes #654