Adds Table of Contents to README #4357
Merged
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.
There's a lot in the README and there's no navigation currently. This adds a table of contents to allow new users to quickly understand what's listed where and jump to relevant sections.
While I was doing this I noticed a few things in the structure of the README that were a bit odd. I've put together this table of contents in a way that I think best represents the logical layout of the README. I would like to hear some opinions on it though, see if we should perhaps consider shifting sections around.