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

React Router: <Replace the link pointing to auto generated useOutletContex docs> #29392

Open
3 tasks done
GaneshS288 opened this issue Feb 7, 2025 · 4 comments
Open
3 tasks done

Comments

@GaneshS288
Copy link
Contributor

GaneshS288 commented Feb 7, 2025

Checks

Describe your suggestion

In Outlets and State section of the lesson the link to useOutletContext docs points to auto generated documentation.

https://reactrouter.com/en/main/hooks/use-outlet-context

This is about as useful as you can imagine. I couldn't find anything on the v7.1.5 docs but the v6.29 docs have proper documentation for useOutletContext, so I suggest changing the link to this

https://reactrouter.com/6.29.0/hooks/use-outlet-context

Path

Node / JS

Lesson Url

https://www.theodinproject.com/lessons/node-path-react-new-react-router

(Optional) Discord Name

evilganesh

(Optional) Additional Comments

No response

@columk1
Copy link
Contributor

columk1 commented Feb 7, 2025

I would also suggest replacing the sentence that recommends the Navigate component:

This is where we use the Navigate component.

Because the page in the docs that it links to says:

It's recommended to avoid using this component in favor of useNavigate

https://api.reactrouter.com/v7/functions/react_router.Navigate.html

@gingkapls
Copy link
Contributor

Are we piling on work on Ganesh? Count me in

The lesson assignment also links to react router tutorial and mentions going up to the "Nested Routes" section. There's another section just below it called "Client Side Routing" that's relevant as well, so we could change the suggestion to read up to "Client Side Routing"

  1. The React Router tutorial goes through a lot of the stuff discussed in this lesson and much more. Have a read through the sections up to “Nested Routes”.

This is a trivial change, so I figured it would be best to include it in this PR while we're at it.

@GaneshS288
Copy link
Contributor Author

GaneshS288 commented Feb 9, 2025

I wouldn't mind. There are more links that I didn't notice at first that seem to be auto generated docs too so they will need to be replaced with proper docs from v6.29.

Also agreed on "client side routing" section being relevant

@CouchofTomato
Copy link
Member

@TheOdinProject/react Can someone take a look at this.

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

4 participants