4 ms·
Since it's a Redux-related thread, I'll toss out one other sub-thread to let people know what we're working on, and ask for feedback. We've already completely
by acemarke 8y ago
Since it's a Redux-related thread, I'll toss out one other sub-thread to let people know what we're working on, and ask for feedback.
We've already completely revamped the React-Redux docs [0]. They're now published as a separate site, and we're writing all-new content, like guides on how to best use `connect`. There's plenty more topics we plan to cover, but it's a big improvement already.
Meanwhile, we're also working on a new build setup for the Redux core docs. Once that's ready, we'll turn our attention to actually revamping the actual Redux docs content and structure. (There's an existing issue if you'd like some info on some of the plans [1]).
So, with that in mind, I'd specifically like to ask:
- What do you think are the biggest strengths and weakness of the current Redux docs at https://redux.js.org https://redux.js.org ?
- What topics do we do well?
- What is not covered, or explained poorly?
- What would be the biggest improvements we can make to the docs structure and content?
I'd appreciate any constructive feedback people can offer.
Finally, we've got a new `redux-starter-kit` package [2] that can help simplify common use cases like store setup, writing reducers, immutable update logic, and even creating "slices" of your store automatically. I'd encourage people to try it out. I talked some about this package in my recent ReactBoston talk on "The State of Redux" [3]. We'll be emphasizing this package when we rework the tutorials and other parts of the docs in the near future.
[0] https://react-redux.js.org https://react-redux.js.org
[1] https://github.com/reduxjs/redux/issues/2590 https://github.com/reduxjs/redux/issues/2590
[2] https://github.com/reduxjs/redux-starter-kit https://github.com/reduxjs/redux-starter-kit
[3] https://blog.isquaredsoftware.com/2018/10/presentation-state-of-redux/ https://blog.isquaredsoftware.com/2018/10/presentation-state...
- davidcsally 8y agoThanks for the great Redux docs. I was not able to find any solid information on how to use Redux with typescript in the docs. Since redux now comes with typescript types (I think), it would be nice to have documentation around how to use them and any best practices to follow and pitfalls to avoid.
- acemarke 8y agoWe've got a work-in-progress PR on adding a docs page to discuss using TS with Redux: https://github.com/reduxjs/redux/pull/3201 https://github.com/reduxjs/redux/pull/3201 . But, neither Tim nor I use TS ourselves (yet), so we're not experts and don't have the expertise to write this ourselves, or maintain the typings. That's gotta come from the community. The React-Redux typings are separate, in Definitely Typed. We're considering moving the Redux typings over there as well.
- gforge 8y agoI just encountered Flow type issues after the 85 release. I know the type defs are in flow-typed but it would be nice if you could also provide some guidance. There are just so many parameters for connect that it just blows my mind when I try to find the source error.
- acemarke 8y agoUnfortunately, that's not something we have any control over, or any real guidance on. Per my other comment in this thread, Tim and I don't use TS or Flow ourselves, and we haven't directly maintained the typedefs.
- gforge 8y agoHave you considered asking the authors of the typedefs to contribute to that section? My guess they would be pretty honored to be able to help out directly with such a high profile package. I like types (I've use both Flow and Typescript) in general, but I can also admit that they can cause more type specific coding that is unrelated to the actual problem that I want to solve. It's somewhat of a rabbit hole though, it is hard to go back once you've started. It would therefore be great if there was something more than the test cases provided at flow-typed when trying to to learn redux typing.