doc: Minor doc updates #1688
Merged
doc: Minor doc updates #1688
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
neverchanje
approved these changes
Apr 8, 2022
Codecov Report
@@ Coverage Diff @@
## main #1688 +/- ##
=========================================
Coverage 69.43% 69.43%
Complexity 2766 2766
=========================================
Files 1058 1058
Lines 93393 93393
Branches 1790 1790
=========================================
+ Hits 64849 64852 +3
+ Misses 27653 27650 -3
Partials 891 891
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
Sunt-ing
approved these changes
Apr 8, 2022
skyzh
reviewed
Apr 8, 2022
skyzh
approved these changes
Apr 8, 2022
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.
What's changed and what's your intention?
Minor updates to the documentation section in readme & minor adjustments to the CONTRIBUTING.md
Please explain IN DETAIL what the changes are in this PR and why they are needed:
Summarize your change (mandatory)
Clarified the purposes of user docs and developer docs, and slight adjustments to the starting section (and various headings) in CONTRIBUTING.md
How does this PR work? Need a brief introduction for the changed logic (optional)
Describe clearly one logical change and avoid lazy messages (optional)
Describe any limitations of the current code (optional)
Checklist
Refer to a related PR or issue link (optional)