aurelia / aurelia/documentation

Router: Missing Generate URL's documentation

Open
#401 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
104
Forks
108
PR merge metrics
No merged PRs in 30d

Description

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](https://user-images.githubusercontent.com/5333676/55991383-73e39080-5caa-11e9-8ec0-0c3975e5e128.png)

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

Contributor guide

Open the contributing guide

Research direction

Start with the main router documentation and the cheat sheet's “Generating Route URLs” section. Document the commonly used generate, navigateTo, and route-href functions, plus NavigationOptions as used by navigateTo. Done means the main router documentation covers these items with the cheat sheet as a consistent reference.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.