{"action":"created","issue":{"url":"https://api.github.com/repos/reduxjs/react-redux/issues/1001","repository_url":"https://api.github.com/repos/reduxjs/react-redux","labels_url":"https://api.github.com/repos/reduxjs/react-redux/issues/1001/labels{/name}","comments_url":"https://api.github.com/repos/reduxjs/react-redux/issues/1001/comments","events_url":"https://api.github.com/repos/reduxjs/react-redux/issues/1001/events","html_url":"https://github.com/reduxjs/react-redux/issues/1001","id":351673413,"node_id":"MDU6SXNzdWUzNTE2NzM0MTM=","number":1001,"title":"Rewrite React-Redux docs completely","user":{"login":"markerikson","id":1128784,"node_id":"MDQ6VXNlcjExMjg3ODQ=","avatar_url":"https://avatars1.githubusercontent.com/u/1128784?v=4","gravatar_id":"","url":"https://api.github.com/users/markerikson","html_url":"https://github.com/markerikson","followers_url":"https://api.github.com/users/markerikson/followers","following_url":"https://api.github.com/users/markerikson/following{/other_user}","gists_url":"https://api.github.com/users/markerikson/gists{/gist_id}","starred_url":"https://api.github.com/users/markerikson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/markerikson/subscriptions","organizations_url":"https://api.github.com/users/markerikson/orgs","repos_url":"https://api.github.com/users/markerikson/repos","events_url":"https://api.github.com/users/markerikson/events{/privacy}","received_events_url":"https://api.github.com/users/markerikson/received_events","type":"User","site_admin":false},"labels":[{"id":703909966,"node_id":"MDU6TGFiZWw3MDM5MDk5NjY=","url":"https://api.github.com/repos/reduxjs/react-redux/labels/docs","name":"docs","color":"0052cc","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":26,"created_at":"2018-08-17T17:18:01Z","updated_at":"2018-10-22T18:49:03Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"The current React-Redux docs aren't very helpful, for a lot of reasons:\r\n\r\n- They're just a Markdown file in the repo, instead of being published in HTML form\r\n- It feels very \"dense\" and jargon-heavy\r\n- It doesn't clearly lay out the various options for `connect` and ways that you can use it\r\n- It's primarily in API reference form, rather than a \"how to\"\r\n\r\nWe do also have the \"Using React with Redux\" page over in the main Redux docs, which is a bit more of a \"getting started\" page, but it's also not great.\r\n\r\nSo, I would really like to completely rewrite our React-Redux docs from scratch.\r\n\r\nAs a rough outline, what I'd like to see is:\r\n\r\n- Quick Start (copy-pasteable examples that show how to add `<Provider>` and do a basic call to `connect()`\r\n- How It Works (an explanation of how `<Provider>` makes the store accessible, and roughly what `connect` does internally to subscribe and extract data)\r\n- Advanced Techniques / Recipes (examples of things like using the \"factory function\" syntax for per-component selector memoization)\r\n- API Reference (something similar to what we have now)\r\n\r\nI do already have a Gitbook setup configured for this, same as the main Redux docs.  I should be able to get the `react-redux.js.org` domain name for this.\r\n\r\nWe can use some of the info from my Redux Fundamentals Workshop slides at https://blog.isquaredsoftware.com/2018/06/redux-fundamentals-workshop-slides/ to help fill this out.\r\n\r\nThere's a related Redux docs issue for revamping the Redux portion of the docs at https://github.com/reduxjs/redux/issues/2591 as well."},"comment":{"url":"https://api.github.com/repos/reduxjs/react-redux/issues/comments/431934028","html_url":"https://github.com/reduxjs/react-redux/issues/1001#issuecomment-431934028","issue_url":"https://api.github.com/repos/reduxjs/react-redux/issues/1001","id":431934028,"node_id":"MDEyOklzc3VlQ29tbWVudDQzMTkzNDAyOA==","user":{"login":"markerikson","id":1128784,"node_id":"MDQ6VXNlcjExMjg3ODQ=","avatar_url":"https://avatars1.githubusercontent.com/u/1128784?v=4","gravatar_id":"","url":"https://api.github.com/users/markerikson","html_url":"https://github.com/markerikson","followers_url":"https://api.github.com/users/markerikson/followers","following_url":"https://api.github.com/users/markerikson/following{/other_user}","gists_url":"https://api.github.com/users/markerikson/gists{/gist_id}","starred_url":"https://api.github.com/users/markerikson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/markerikson/subscriptions","organizations_url":"https://api.github.com/users/markerikson/orgs","repos_url":"https://api.github.com/users/markerikson/repos","events_url":"https://api.github.com/users/markerikson/events{/privacy}","received_events_url":"https://api.github.com/users/markerikson/received_events","type":"User","site_admin":false},"created_at":"2018-10-22T18:49:03Z","updated_at":"2018-10-22T18:49:03Z","author_association":"CONTRIBUTOR","body":"@zsid : Hi!  You can see a list in the previous comments of some of the other pages we'd like to add.\r\n\r\nPerhaps a good place to start would be to start adapting my post [Idiomatic Redux: Using Reselect Selectors for Performance and Encapsulation](https://blog.isquaredsoftware.com/2017/12/idiomatic-redux-using-reselect-selectors/) into a docs page.  If you'd like to work one of the other possible pages as well, that would also be great."}}
{"actor":{"display_login":"markerikson"}}