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 is follow-up from a community call last week, where we discussed the README. The current state of the README is very long and it requires a lot of scanning/scrolling/searching to find what you might be looking for. With the goal of making things easier to adopt for newcomers, I set out to reduce some of the first-view GIANT WALL OF HIGHLY TECHNICAL TEXT impression.
This change pulls out a few larger chunks of the README into their own docs (within the docs subdir). I feel that this separation is natural and should be easier for newcomers to navigate. It also adds table of contents to the main readme and to the new files. In a few places I've tried to add friendly/encouraging language and/or make wording simpler.
It's probably obvious, but if you want to see this in action you can click through to the PR branch.