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

Router: Missing Generate URL's documentation #401

Open
CasiOo opened this issue Apr 11, 2019 · 3 comments
Open

Router: Missing Generate URL's documentation #401

CasiOo opened this issue Apr 11, 2019 · 3 comments

Comments

@CasiOo
Copy link

CasiOo commented Apr 11, 2019

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
Copy link
Contributor

@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
Copy link

stsje commented Apr 12, 2019

@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
Copy link
Contributor

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants