Added more context to the README sections #225
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
Added context to the Quick Start along with links to the reference material at the top of the README Added context to the Usage section Added a separator between Quick Start and Usage, as well as adjusting the headers to specifically call out the different sections as physically and logically different.
|
|
cretz
reviewed
Dec 8, 2022
|
@cretz I believe I have resolved all the comments. Please let me know if you see anything else. Thanks for catching my inconsistencies! |
cretz
approved these changes
Dec 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 was changed
Added context to the Quick Start along with links to the reference material at the top of the README Added context to the Usage section
Added a separator between Quick Start and Usage, as well as adjusting the headers to specifically call out the different sections as physically and logically different.
Why?
I got confused while working through the README and totally missed the links at the top, bc I got distracted and excited about "Quick Start"
Checklist