Update README.md #1099
Merged
Update README.md #1099
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
On starting into the README I saw it could use a TOC. On adding a TOC I saw some header issues. On working through the header issues I found some organizational opportunities. I think these changes should help newcomers (like me) trying to work through the giant README.
Member
martincostello
left a comment
martincostello
left a comment
There was a problem hiding this comment.
Thanks for your contribution. Just a few minor comments.
Add extension used to maintain the new TOC.
kmgallahan
commented
Apr 5, 2023
Contributor
Author
kmgallahan
left a comment
kmgallahan
left a comment
There was a problem hiding this comment.
Suggestions implemented.
Suggestions implemented Co-authored-by: Martin Costello <[email protected]>
martincostello
approved these changes
Apr 5, 2023
Member
|
Thanks! |
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
The issue or feature being addressed
On starting into the README I saw it could use a TOC.
Details on the issue fix or feature implementation
On adding a TOC I saw some header issues.
On working through the header issues I found some organizational opportunities.
I think these changes should help newcomers (like me) trying to work through the giant README.
Confirm the following