​​Redux docs - draft rewrite outline

​​Notes and references:

​​

​​Related Issues and Prior Discussion

​​
 
https://github.com/reduxjs/redux/issues/2590
/
​​
​​reduxjs/redux#2590
​​
 
https://github.com/reduxjs/redux/issues/2591
/
​​
​​reduxjs/redux#2591
​​
 
https://github.com/reduxjs/redux/issues/2591
/
​​
​​reduxjs/redux#2591
​​
 
https://github.com/reduxjs/react-redux/issues/1001
/
​​
​​reduxjs/react-redux#1001
​​

​​Best Other Tutorials

​​
​​https://blog.isquaredsoftware.com/2018/06/redux-fundamentals-workshop-slides/
​​https://blog.isquaredsoftware.com/series/practical-redux
​​philosophy and intent: https://blog.isquaredsoftware.com/series/idiomatic-redux
​​https://redux.js.org/introduction/learningresources
​​“best of” list in the current docs: https://redux.js.org/#learn-redux 
​​

​​Other Thoughts

  • ​​Varying target audiences / learning styles
  • ​​People are new to JS/React/etc
  • ​​Experienced devs
  • ​​So hard to write the new docs. Many different audiences to cater to.
  • ​​Should make sense to: Flux beginners, FP people, FP people who don't get Flux, Flux people who don't get FP, normal JS people too
  • ​​Flux people: “is this proper Flux?” FP people: “is this that weird thing called Flux?” Normal people: “why not Backbone”
  • ​​Want to split up much of the “how to” vs the “why are things like this”
  • ​​Assume we have an “official Redux” version of redux-starter-kit​ published. How do we fit that into the docs, and recommend its usage?
  • ​​Could probably fit this into the “Quick Start” section as a minimum
  • ​​CodeSandbox examples embedded in the docs
  • ​​How does that work with Gitbook?
  • ​​Minimize non-Redux explanations in the docs - throw in external references links to other topics
  • ​​Emphasize “reducer” terminology source and similarity with someArray.reduce()​ ( reference )
​​

​​Tanner’s ​🧠​:

  • ​​What is Redux?
  • ​​Short Example
  • ​​Getting Started / Quick Start
  • ​​Assumes all knowledge (or no desire to learn how/why)
  • ​​Installation
  • ​​Usage
  • ​​Tutorial & Concepts
  • ​​(Briefly explain each facet of redux and their purpose)
  • ​​Assume all non-redux knowledge (js, es6, async)
  • ​​Store
  • ​​Reducers
  • ​​Dispatch