[Docs Rewrite] Meta-Issue: Overview

[markerikson]

This is the parent tracking issue for all the work we'd like to do, and primarily serves to link to the other issues.

I'm initially basing this off my suggested outline for the new docs structure and content. This is absolutely not final, and I expect us to iterate on this a lot as we work through everything.

For now, I'm organizing the top-level task list by category / docs structure section.

Tasks

• Guided Learning Paths ([Docs Rewrite] Meta-Issue: Guided Learning Paths #3591)
• General Content Improvements ([Docs Rewrite] Meta-Issue: General Content Improvements #3593)
• "Introduction" section ([Docs Rewrite] Meta-Issue: Introduction section #3594)
• "Tutorials" section ([Docs Rewrite] Meta-Issue: Tutorials #3595)
• "Recipes" section ([Docs Rewrite] Meta-Issue: Recipes section #3596)
• "FAQ" section ([Docs Rewrite] Meta-Issue: FAQ #3597)
• "Real World Usage" section ([Docs Rewrite] Meta-Issue: Using Redux #3598)
• "Using Redux with a UI" section ([Docs Rewrite] Meta-Issue: Using Redux with a UI #3599)
• "Understanding Redux" section ([Docs Rewrite] Meta-Issue: Understanding Redux section #3600)
• "Style Guide" section ([Docs Rewrite] New Page: Style Guide #3601)
• "Other" section and content ([Docs Rewrite] Meta-Issue: Other Content #3602)
• Redux Starter Kit section ([Docs Rewrite] Meta-Issue: Redux Toolkit section #3614 )
• Examples ([Docs Rewrite] Meta-Issue: Rewrite Examples #3917)

Planning / Discussion Topics

• Docs writing guidelines and issue templates ([Docs Rewrite] Discussion: Docs writing guidelines and issue templates #3609 )
• Ideas from other docs sites and user feedback ([Docs Rewrite] Discussion: Ideas from Other Docs and Resources #3615 )

Notes

Any pages that are moved around must update our Netlify redirects file so that visitors see the new page.

Questions for Discussion

• Should we keep everything on a single docs-rewrite integration branch, or should we just go ahead and update master piecemeal as we go so that we get the initial benefits? I'm inclined to put changes into master as soon as we're happy with them.

[asedsami]

I'm not sure if this is the right issue to say this, or if there are other people who read docs and tutorials on their phones while lying on the sofa, but please reduce the height of the purple part in mobile screens(horizontal).
The content takes only half the height of the screen which makes it hard to read the docs. note that "getting started", "API" and "FAQ" are already at the hamburger menu.

[markerikson]

@asedsami : can you file a separate issue for that? That would probably most relate to potentially updating Docusaurus to v2 (related: #3584 ).

[markerikson]

Not sure if it's better suited for this thread or #3593, but @dai-shi has put together a Remark plugin for Docusaurus v2 that lets you write snippets in TS, and automatically have a tabbed code block added with that snippet in both TS and plain JS:

https://twitter.com/dai_shi/status/1197816235058069504

We could maybe even take that further and have it do TS, ES6, and ES5.

[hbarcelos]

Hi guys, I would be glad to help with this issue. I'll read through it tomorrow.