Skip to content
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

[2.0] Finalize docs #3744

Closed
26 tasks done
markerikson opened this issue Sep 25, 2023 · 9 comments
Closed
26 tasks done

[2.0] Finalize docs #3744

markerikson opened this issue Sep 25, 2023 · 9 comments
Milestone

Comments

@markerikson
Copy link
Collaborator

markerikson commented Sep 25, 2023

Figure out any docs changes that might be needed and update them:

RTK

  • Remove deprecations
  • Document new features
  • Set up error codes page for RTK
  • Document selectSlice
  • Look for uses of @reduxjs/toolkit/dist in the docs
  • Update TS usage to mention getState() as RootState plus an explicit return type
  • Mention isAction in the migration guide
  • Update repo README
  • Land the Next.js usage docs
  • Reselect ParametricSelector removal (and weakMapMemoize as default?)
  • Rename migration page and update release note links in existing RCs for completeness)
  • Make sure middleware comes before enhancers so we can infer types for getDefaultEnhancers correctly

Core

  • Update repo README
  • Land the Next.js usage
  • Add error codes page to sidebar for core
  • Core docs TS changes?
  • Copy migration guide
  • document isAction and isPlainObject
  • Be sure to mention createStore deprecation in the core API ref

Release Notes

  • Redux core
    • createStore deprecation
  • RTK
    • createStore deprecation
    • Reselect weakMapMemoize, lruMemoize, and dev checks
  • Reselect
  • React-Redux
@markerikson markerikson added this to the 2.0 milestone Sep 25, 2023
@markerikson markerikson changed the title Finalize docs [RED-27] Finalize docs Sep 25, 2023
@markerikson markerikson changed the title [RED-27] Finalize docs [RED-28] Finalize docs Sep 25, 2023
@markerikson markerikson changed the title [RED-28] Finalize docs [RED-27] [RED-28] Finalize docs Sep 25, 2023
@markerikson
Copy link
Collaborator Author

Should add the copy-paste of the extracted errors page, per #3374

@EskiMojo14
Copy link
Collaborator

new selectSlice method of slices will need documenting: #3838

@markerikson
Copy link
Collaborator Author

Check uses of augmentation like "@reduxjs/toolkit/dist/query/whatever", per the RTKQ enhancement pages.

@markerikson
Copy link
Collaborator Author

Need to update the Redux templates, too.

@markerikson
Copy link
Collaborator Author

Not 2.0 related, but we should add something to "RTK TS Usage" saying you need to explicitly cast getState() as RootState and have an explicit return type to avoid circular type inference

@EskiMojo14
Copy link
Collaborator

as per #3895 we should probably mention isAction in the migration guide

@markerikson
Copy link
Collaborator Author

Land the Next usage docs PR here and in the core site

@markerikson
Copy link
Collaborator Author

Update all repo READMEs with whatever the latest template and descriptions are

@markerikson markerikson changed the title [RED-27] [RED-28] Finalize docs [2.0] Finalize docs Nov 23, 2023
@EskiMojo14
Copy link
Collaborator

since the migration guide mentions the stability dev check, it should mention the identity function check too

@markerikson markerikson closed this as not planned Won't fix, can't repro, duplicate, stale Mar 26, 2024
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

No branches or pull requests

2 participants