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

Docs: README doesn't coincide with what is in the example code (pages/_app.js) #39555

Closed
thebuddysystem opened this issue Aug 12, 2022 · 4 comments
Labels
examples Issue/PR related to examples good first issue Easy to fix issues, good for newcomers

Comments

@thebuddysystem
Copy link

thebuddysystem commented Aug 12, 2022

What is the improvement or update you wish to see?

I would like to see the documentation in the README be consistent with what's in the code.

In the next.js/examples/with-redux-thunk README.md, it states:

... The MyApp component is wrapped in a withReduxStore function ...

However, in the code at pages/_app.js there is no MyApp component nor is there a withReduxStore function, so it's really confusing. I'm guessing that got replaced with the hook in _app.js called useStore??

Additionally, it states:
1.) pages/index.js will utilize connect from react-redux ...
which seems wrong, because there's no call to any connect function in the actual code.

Also the last sentence states:
... then in store.js change (line 19) store.replaceReducer(createNextReducer(initialState)) to store.replaceReducer(createNextReducer).
that also seems wrong because i can't find store.replaceReducer anywhere.

Is there any context that might help us understand?

Just read the README and try to follow along in the code.

Does the docs page already exist? Please link to it.

https://github.com/vercel/next.js/tree/canary/examples/with-redux-thunk/README.md

@thebuddysystem thebuddysystem added the Documentation Related to Next.js' official documentation. label Aug 12, 2022
@balazsorban44 balazsorban44 added examples Issue/PR related to examples good first issue Easy to fix issues, good for newcomers and removed Documentation Related to Next.js' official documentation. labels Aug 13, 2022
@jmorel88
Copy link

@balazsorban44 I'll be happy to take this one.

kelvin9314 added a commit to kelvin9314/next.js that referenced this issue Aug 16, 2022
kelvin9314 added a commit to kelvin9314/next.js that referenced this issue Aug 18, 2022
kelvin9314 added a commit to kelvin9314/next.js that referenced this issue Aug 19, 2022
kodiakhq bot pushed a commit that referenced this issue Aug 20, 2022
## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)

This change is related to issue #39555  

PTAL, Thanks




Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
@mayanhavoc
Copy link

Is this issue still open? Seems like the desired changes in the documentation have been made.

@thebuddysystem
Copy link
Author

Oh, should i be closing it, since i opened it?
In any case, Thanks everyone!!!

@github-actions
Copy link
Contributor

This closed issue has been automatically locked because it had no new activity for a month. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue/PR related to examples good first issue Easy to fix issues, good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants