[Docs Rewrite] Meta-Issue: Redux Toolkit section

[markerikson]

This is a tracking issue to cover all work related to adding a miniature version of the RTK docs to the Redux core docs.

Concept

The idea is to specifically document RTK within the core Redux docs, in the same way that we have information on using React-Redux in the core. First suggested here: reduxjs/redux-toolkit#246 (comment) .

For simplicity, I think we should probably just copy-paste most or all of the API docs and the "Usage Guide" page, but not the tutorials. We can point to the main RTK docs site for those. Or, perhaps we could have sidebar links that just point directly to the RTK docs pages. Some of that may require waiting for an upgrade to Docusaurus v2.

Tasks

• Determine which portions of the RTK content should be available in the Redux core docs
• Determine approach for copying or linking content
• Add content

[markerikson]

Paging the Docusaurus folks: @wgao19 , @endiliey , @yangshun .

Can we add external links to the sidebar in DS v1, or just in v2?

[yangshun]

Hmm I don't think so. @endiliey could we backport this feature? Since it's available in v2 and the API is the same.

[endiliey]

Sorry but I think adding this to v1 back isnt that easy although lot of API in v2 stays the same, the underlying code is very different (its a re-write after all). I am hesitant to add it back to v1 since there’s almost no tests in v1 on that part and it could cause regression. (In v2 we have 100% test coverage on docs functionality so regression is harder).

[markerikson]

Okay. Maybe for now we should just have a small section with an "Overview" page, and link to the RTK docs pages from that page. Could also add a single-page miniature version of the RTK API reference.

[markerikson]

Settled on just adding an "Overview" page for now that reuses some of the text from the RTK "Getting Started" page to describe what RTK is and why you should use it. I added links to the individual RTK API reference pages at the bottom.

That should suffice for now. I'll close this, and we can re-open it if we feel there's more work to be done.