Skip to content

Add "use modern Redux" warnings to Fundamentals pages #4496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 7, 2023

Conversation

markerikson
Copy link
Contributor

@markerikson markerikson commented Mar 6, 2023

This PR:

  • Adds a "warning" callout to most "Fundamentals" pages clarifying that the page intentionally shows outdated hand-written patterns for the purpose of explanation, and that you should look at the "Essentials" tutorial to learn how to use RTK
    • Exceptions: Part 1 (already has a similar blurb), Part 5 (React-Redux usage is the same), Part 8 (already shows RTK migration)
  • Updates both "Quick Start" pages to more clearly state "go to 'Essentials' next"
  • Adds a recommendation reasons section with "why RTK Query / listeners, not sagas"

Fixes #4495 .

Example:

(can't upload a picture due to lousy airplane wifi)

I'm totally open to suggestions for improving the callout text, or choosing a different color (blue for "info"? red for "caution"? add CSS to make it blink?)

@markerikson markerikson requested a review from phryneas March 6, 2023 20:17
@netlify
Copy link

netlify bot commented Mar 6, 2023

Deploy Preview for redux-docs ready!

Name Link
🔨 Latest commit d664c72
🔍 Latest deploy log https://app.netlify.com/sites/redux-docs/deploys/6406c3c433c13c0008594717
😎 Deploy Preview https://deploy-preview-4496--redux-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@codesandbox-ci
Copy link

codesandbox-ci bot commented Mar 6, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d664c72:

Sandbox Source
Vanilla Configuration
Vanilla Typescript Configuration

@markerikson markerikson force-pushed the docs/tutorials-instructions branch from 8a6809a to 8807b66 Compare March 7, 2023 01:44
@markerikson markerikson force-pushed the docs/tutorials-instructions branch from 8807b66 to d664c72 Compare March 7, 2023 04:55
@markerikson markerikson merged commit 85a8900 into master Mar 7, 2023
@markerikson markerikson deleted the docs/tutorials-instructions branch March 7, 2023 05:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve "Essentials" and "Fundamentals" tutorial instructions and differentiation
1 participant