-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
https://react-redux.js.org/api shows "7.1" version but outdated docs #1497
Comments
Hmm. That.... page shouldn't even exist? We now have individual docs pages for the different APIs ( and while there was briefly a https://react-redux.js.org/5.x/api I'm not even sure how that page was created at this point. In addition, note that it's not showing the left sidebar at all, which is an indication that this page is orphaned somehow. |
just a hunch - it could be a cache issue or a leftover from older build that wasn't cleared properly |
This is a bug/feature/flaw of the v1 versioning system. Any files within docs will have a page created and in v1, because the versioning system only creates new files if it differs from the previous version, it is unable to differentiate if a file is removed or if it was unchanged. Sadly this is a flaw in the design and is not possible to change in v1 without breaking users who rely on this behavior. Once a doc page is created, it cannot be removed unless the root fallback is removed. One way to fix this is to delete the v5 docs, which is probably not a good idea. More info in facebook/docusaurus#2123. This issue is addressed in v2's versioning approach which snapshots all the docs for a version and doesn't use any flawed fallback logic. |
@yangshun : now that we've got Redux Toolkit and the Redux core docs updated to v2, would someone be able to tackle updating React-Redux to v2 as well? |
It's gonna be a complicated move and this will be the first versioned site to move. I'll probably take up this migration myself, but it'll take a while. |
We've upgraded to DSv2 in #1638 , so I think this is fixed now. |
Do you want to request a feature or report a bug?
Yes
What is the current behavior?
I got on https://react-redux.js.org/api most likely from a DDG search or somebody linking it in SO or something. Documentation lists
createProvider
which we were using but was removed since version 6 or so, however label on top shows version 7.1 so it was very confusing that API documentation is outdated and there are no references tocreateProvider
in documentation sourceIf the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. Your bug will get fixed much faster if we can run your code and it doesn't have dependencies other than React. Paste the link to a CodeSandbox (https://codesandbox.io/s/new) or RN Snack (https://snack.expo.io/) example below:
createProvider
- it's goneWhat is the expected behavior?
https://react-redux.js.org/api redirects to most recent documentation or gives 404 or updated to reflect recent changes or show correct version.
Which versions of React, ReactDOM/React Native, Redux, and React Redux are you using? Which browser and OS are affected by this issue? Did this work in previous versions of React Redux?
Firefox.
The text was updated successfully, but these errors were encountered: