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

Problem with docs in /getting-started section . #1727

Closed
SiddheshKukade opened this issue Jun 3, 2021 · 2 comments
Closed

Problem with docs in /getting-started section . #1727

SiddheshKukade opened this issue Jun 3, 2021 · 2 comments

Comments

@SiddheshKukade
Copy link

URL : https://react-redux.js.org/introduction/getting-started#hooks

On this URL Hooks Section you can see this following code ⬇️

temp

🔴 Problem :
You can see in the above code that we are importing some functions from ./userSlice

import { decrement, increment, incrementByAmount, incrementAsync, selectCount, } from './counterSlice'

And if you checked the entire page there is no information [or even hint ] aboout what does this ./counterSlice contains

🔵 My Suggestion :
Please add the documentation about what actually the page contains or share the contents of that file so that there will be no confusion for beginners.

Thank you for Reading this. 🤝

@markerikson
Copy link
Contributor

A couple quick thoughts:

  • The focus of the React-Redux docs site is to teach how to use the React-Redux library. React-Redux is used with Redux itself, either Redux Toolkit or the original Redux core. The React-Redux docs assume you already know Redux.
  • This is just a "Getting Started" page, and that snippet is just trying to illustrate what some basic usage code looks like.

If you aren't comfortable with Redux already, please see the Redux core docs tutorials. They cover fundamental Redux concepts, Redux Toolkit, and React-Redux:

https://redux.js.org/tutorials/index

@SiddheshKukade
Copy link
Author

A couple quick thoughts:

  • The focus of the React-Redux docs site is to teach how to use the React-Redux library. React-Redux is used with Redux itself, either Redux Toolkit or the original Redux core. The React-Redux docs assume you already know Redux.
  • This is just a "Getting Started" page, and that snippet is just trying to illustrate what some basic usage code looks like.

If you aren't comfortable with Redux already, please see the Redux core docs tutorials. They cover fundamental Redux concepts, Redux Toolkit, and React-Redux:

https://redux.js.org/tutorials/index

Thank you Sir . 👍

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