Add a "Usage Guide" docs page #105
Conversation
|
Deploy preview for redux-starter-kit-docs ready! Built with commit 95bf2be https://deploy-preview-105--redux-starter-kit-docs.netlify.com |
There was a problem hiding this comment.
Nice to see that Redux Starter Kit is getting non-reference documentation! 👍 I added a few pieces of feedback, I hope they help you.
In general, I think what's still missing a bit is a clear picture in what should go into the Usage Guide and what rather belongs into the API documentation. I think the former should be focus on use cases - going through common tasks when writing a Redux app, pointing at and giving examples for the relevant utility functions, then referring to those functions' API docs for all of the details. Viewed like this, the createReducer section of the Usage Guide is a bit too extensive, for instance. But perhaps you have a different split in mind?
|
Just pushed a bunch of changes. @denisw , I took most of your suggested edits into account, although I left some of the things like the "declaring functions in an object" section in place. I agree there's some overlap between the API reference pages and the Usage Guide, but I don't think that's necessarily a bad thing. It can be helpful to have the same info in multiple places, because people might be looking at the docs for different reasons. In general, this page is intended to be more of a "how to". We can always tweak it further later, but I want to get the current content merged in shortly. |
* Allow for a custom fetch fn, fix isOnline * Inspect response from msw in tests instead of using a spy
The individual API reference pages have some "how to use this" info, but we clearly need a specific page that gives guidance on how to use RSK correctly.
Wrote up the first chunk of this over the weekend. It's not complete yet, but I figured it's worth getting the preview up in case anyone has feedback.