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 Getting Started Section to the New Docs #1017

Merged
merged 3 commits into from
Sep 17, 2018

Conversation

wgao19
Copy link
Contributor

@wgao19 wgao19 commented Sep 8, 2018

What does this PR do?

As discussed in #1001 we are rewriting the documentation for react-redux. This PR adds the Quick Start section to the new docs.

Are there points in the code the reviewer needs to double check

Some of the code snippets are wrapped with the github <details> tag. We're not sure how they will render in the gitbook generated doc site.

Summary of the changes

Quick Start section outline

  • Summary what React-Redux does
  • Guide the reader how to use React-Redux, aiming at covering the most common cases (and making references to further readings)
  • Contains CodeSandbox snippets

@wgao19 wgao19 force-pushed the wgao19/docs-getting-started branch 4 times, most recently from 045ca52 to 0ce9d35 Compare September 9, 2018 02:50
@wgao19 wgao19 force-pushed the wgao19/docs-getting-started branch 9 times, most recently from a03930c to bbfba50 Compare September 14, 2018 16:48
@wgao19 wgao19 force-pushed the wgao19/docs-getting-started branch 4 times, most recently from 1b75d18 to d813927 Compare September 17, 2018 15:52
…, add illustrations on store changes with DevTools, and remove the paragraph on containers.
@wgao19 wgao19 force-pushed the wgao19/docs-getting-started branch from d813927 to b6b3651 Compare September 17, 2018 16:00
@markerikson
Copy link
Contributor

Awright, looks pretty good. I see a couple more small edits I want to make, but let's go ahead and get this in now and I'll take care of those edits myself.

Thank you SO much for putting this together! :)

@markerikson markerikson merged commit e817572 into reduxjs:master Sep 17, 2018
@wgao19 wgao19 deleted the wgao19/docs-getting-started branch September 18, 2018 04:11
albertodev7 pushed a commit to albertodev7/react-redux that referenced this pull request Dec 8, 2022
* Add Getting Started section to the new docs

* Revisions 1: Normalize `todos` store shape, add an overview section.

* Revisions 2: Refactor selectors to alleviate verbose existence checks, add illustrations on store changes with DevTools, and remove the paragraph on containers.
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