Mention certain components must be children of Router

[sasacocic]

Description

I've added documentation explaining that certain elements like <Link /> & <Switch /> must be nested inside of a router.

Fixes #2903

[sasacocic]

I've been using yew for a little bit now and have some ideas about improving documentation for yew. These aren't complete thoughts, but I just wanted to share what was on my mind as it might be helpful.

Also to share my experience reading the docs:

• I will found the Tutorial to be helpful, but the actual Docs section not that helpful. Often I felt it included a lot of verboseness that deviated from just explaining the core of the concept and how to use it.

I'm not in the loop about what is being done with the docs, but my suggestion is to overall structure the documentation more like reacts. Yew does this to an extent already, but it could be better e.g.

• The callback documentation on paper makes sense, but when I tried to use it ... it didn't really make sense how to use it. Coming from react I expected to just be able to directly pass closures or functions around, but this wasn't the case. There was a bit of friction and I had to actually go dig through the code (and ask for help in discord) for what I was trying to do (pass a function as a prop to one of my components) - in this case I think just doing a more in depth example with more code could really help here.

TLDR; more code and detail to describe and communicate the concepts

Also, I'm willing to help with more documentation efforts especially with the things I've had a bit of trouble with like passing a function as a prop

Also, as a general question is it just better to put up PRs here rather than just propose things?

[WorldSEnder]

Also, as a general question is it just better to put up PRs here rather than just propose things?

If you have a ready proposition that improves things, a PR is welcome. If it's unclear what to change and you want to figure things out first, the have a few tags you can apply to your issue, among them documentation, question and ergonomics.

[WorldSEnder]

Overall nicer to read. I think the phrasing is still a bit verbose and vague. A link to the context docs could be helpful.

[ranile]

The fixes need to be added in both files

[sasacocic]

Also, I'll squash these commits together into one whenever merging

[sasacocic]

Just wanted to bump this it's been a little while.

[SpanishPear]

noticed some small typos

[github-actions]

Visit the preview URL for this PR (updated for commit c574adb):

https://yew-rs--pr2913-sasa-update-router-d-29rueg3o.web.app

_{(expires Thu, 15 Dec 2022 06:19:25 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

[WorldSEnder]

Hey. @sasacocic . Just wanted to let you know that I really appreciate your patience on this :D It might feel like this is getting more scrutiny and change requests than a usual documentation change, which I think is because we're nearing release and want to get it exactly right. Thanks for your perseverance and understanding in keeping up with all the different opinions.

[sasacocic]

@WorldSEnder no worries :)

[ranile]

Sorry, I forgot this PR was waiting on me. @sasacocic can you please update the PR so it can be merged. If you don't want to, that's fine. I can do that for you

[sasacocic]

@hamza1311 I've updated it. Along with the documentation for 0.20.0. I can revert the change in 0.20.0. if that's necessary. Sorry, for seeing this so late. Got caught up with some stuff.

[WorldSEnder]

Thanks for also updating the old docs, there are still quite a lot users around, so it's worth the effort. Only comment from me is fixing some missing quotes for code markup.