aurelia / aurelia/documentation
Links between classes in documentation app
- Dominant language
- No language data
- Stars
- 104
- Forks
- 108
- PR merge metrics
- No merged PRs in 30d
Description
It would be extremely helpful if wherever other classes are referenced, the documentation linked to that class. Currently, you generally have to go back to some route point and find each class yourself.
For example (from Router):
```
currentInstruction: NavigationInstruction
The currently active navigation instruction.
```
NavigationInstruction should link to the navigation instruction class definition.
Contributor guide
Research direction
Start with the Router documentation example and inspect how the NavigationInstruction class definition is represented. Trace how class references are rendered in the documentation app, then verify that referenced classes link to their definitions wherever they appear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100