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

Add docs for nested router #2182

Closed
1 of 5 tasks
Madoshakalaka opened this issue Nov 23, 2021 · 4 comments · Fixed by #2192
Closed
1 of 5 tasks

Add docs for nested router #2182

Madoshakalaka opened this issue Nov 23, 2021 · 4 comments · Fixed by #2192
Labels
A-yew-router Area: The yew-router crate documentation

Comments

@Madoshakalaka
Copy link
Member

This is about:

  • A typo
  • Innaccurate/misleading documentation (e.g. technically incorrect advice)
  • Undocumented code
  • Outdated documentation
  • Other

Problem
Current documentation doesn't make it obvious how routers can nest within each other.

here is an example of how this could be done by @mc1098
#2097 (comment)

However, it needs to be updated because of recent updates to the router.

@Madoshakalaka
Copy link
Member Author

I'm interested in doing this

@Madoshakalaka
Copy link
Member Author

It's not actually "undocumented code". Because nested router is not explicitly a feature in the code but just a way how routers can be used together. It's just unclear how this should be done and some instruction is needed.

@Madoshakalaka
Copy link
Member Author

May I also add a nested_router example alongside the current router example?

@ranile
Copy link
Member

ranile commented Nov 23, 2021

Related to #1853. It might be worth tackling that issue first as that improves the ergonomics of nesting routers. Right now, the experience of using nested routers isn't ideal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-yew-router Area: The yew-router crate documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants