Improve documentation of the router

[ranile]

This is about:
Undocumented code

Documentation to be added

• How to specify route parameters, describing the syntax and the possibilities, maybe link to the route_recognizer
• Examples for parsing and pushing query parameters
• Document how to listen to route changes

Originally posted by @siku2 here: #1791 (comment)

Questionaire (Optional)

• I'd like to write this documentation
• I'd like to write this documentation but I'm not sure what's needed
• I don't have time to add this right now, but maybe later

[voidpumpkin]

@hamza1311 Could you convert the points into a checkbox list?
I think the only bit I cant find yet documented is about the RouteListener dropping, first 2 points are already documented

[mc1098]

Could you convert the points into a checkbox list?

@voidpumpkin You have the power to edit issues now that you have joined the dark side of the force (maintainers) 👀

Also as just a quick impression from skimming the Router docs is that it seems function component based so, I think it would be difficult for someone not using function components to workout the alternative. I think this problem will pop up more and more in general so, might be worth looking into using Tabs in Docusaurus to provide both function component and struct component information :).

[ranile]

Using function components also means that the docs show type instead of struct for the components.

Also @voidpumpkin, feel free to update the issue as you see fit. I haven't looked at the new new router yet so I can't say what needs to be documented

[ranile]

Update: last 2 points are still undocumented, first one could have some polish. I'll update the issue with checkboxes