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.
Purpose
Related to #1001
We're working on rewriting the
react-redux
documentation completely. This is the first PR opened to begin that process.The goal of these changes is to make the section on the
<Provider />
more readable and approachable for react-redux users. I'm looking for suggestions on grammar, any missing information, and a sanity check on my code examples.Approach
Folder Structure
I have added a new folder structure based on @markerikson's suggestions. Documentation will continue to live under
/docs
, but I've added a folder at/docs/api
and aProvider.md
file.Updated Docs
I've reworked some of what currently lives in
api.md
as well as referenced some popular tutorials to try to incorporate some language that might be familiar to current users ofreact-redux
.