search

aurelia / documentation

The documentation for Aurelia.
MIT License
105 stars 111 forks source link

Router: Missing Generate URL's documentation #401

Open CasiOo opened 5 years ago

CasiOo commented 5 years ago

The main router documentation is missing some commonly used functions: generate, navigateTo, route-href and a bit off-topic but NavigationOptions used in navigateTo

Cheat sheet has a section for Generating Route URLs that would be a good base for the new documentation. image

It has been a pain for far too long. Time to add it to the docs guys!

EisenbergEffect commented 5 years ago

@CasiOo Thanks for pointing this out. Can yo clarify...is is the "article" on routing that needs a section added on how to use this? (or is it entirely missing from the API section as well)

stsje commented 5 years ago

@EisenbergEffect (CasiOo here) It is missing from Guides > Routing https://aurelia.io/docs/routing . I believe that is the main routing documentation? You can find the functions in the API, but such commonly used functions should be in the guide as well.

EisenbergEffect commented 5 years ago

@stsje @CasiOo Would either of you be interested in submitting a PR to add the missing sections to the documentation? All you have to do is add the Markdown. Here's where our router documentation source is located: https://github.com/aurelia/documentation/tree/master/current/en-us/6.%20routing