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

[Content]: Route props description is out of date and missing props #845

Open
sashalimarev opened this issue Aug 13, 2024 · 0 comments
Open
Labels
help wanted Looking for assistance on this issue improve documentation Enhance existing documentation.

Comments

@sashalimarev
Copy link

📚 Subject area/topic

/solid-router/reference/components/route.mdx

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/solid-router/reference/components/route

📋 Description of content that is out-of-date or incorrect

  • There's no mention of load being deprecated, while the recommended preload is not documented at all.
  • There's also no documentation about the info prop. There is a helpful example in the solid router repo description where info is used together with useCurrentMatches (which is not mentioned anywhere in the docs as well). It would be great to include this vital information in the docs, as I stumbled upon that example by accident.

I think the second point is the most important, since attaching metadata to routes that can't be expressed in the path is a common pattern. I needed this functionality to display a title based on the screen the user navigated to. I poked around the router docs for a while and tried a few approaches until I found info on the RouteProps type.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@sashalimarev sashalimarev added improve documentation Enhance existing documentation. pending review Awaiting review by team members. labels Aug 13, 2024
@LadyBluenotes LadyBluenotes added help wanted Looking for assistance on this issue and removed pending review Awaiting review by team members. labels Aug 27, 2024
@LadyBluenotes LadyBluenotes removed their assignment Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Looking for assistance on this issue improve documentation Enhance existing documentation.
Projects
None yet
Development

No branches or pull requests

2 participants