Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add updated <Provider /> docs #1015

Merged
merged 3 commits into from
Sep 8, 2018
Merged

Conversation

maecapozzi
Copy link
Contributor

@maecapozzi maecapozzi commented Sep 8, 2018

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 a Provider.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 of react-redux.

@markerikson
Copy link
Contributor

First suggestion: actually save the file with the contents inside and THEN push :)

@markerikson
Copy link
Contributor

Maybe doesn't need to be in there right now, but I sometimes see questions from people unsure how to do this in React Native. Part of that is that navigation in React Native varies based on what lib you're using, and there's also not an obvious call like ReactDOM.render(). Having an example or two for React Native (maybe for a couple different navigation libs?) would be beneficial.

@markerikson
Copy link
Contributor

Other than that, looks good. Same basic content we already had, but split out and cleaned up a bit. Aaaaand we're on the way!

@markerikson markerikson merged commit fda9a01 into reduxjs:master Sep 8, 2018
@maecapozzi
Copy link
Contributor Author

One more thing @markerikson forgot to mention before merging: <Provider /> throws an error if you give it more than one child. We might want to add this to the docs.

albertodev7 pushed a commit to albertodev7/react-redux that referenced this pull request Dec 8, 2022
* Add updated Provider docs

* Add Provider documentation

* Update formatting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants