aurelia / aurelia/framework

doc: automatically link classnames to their documentation pages throughout API docs

Open
#648 2 comments 3 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
11.7k
Forks
608
PR merge metrics
No merged PRs in 30d

Description

**I'm submitting a feature request**

I'm not sure if this is the most appropriate place for this request, but I could not find the hub.html app that serves Aurelia documentation open sourced anywhere (so I can't try and implement this on my own to contribute).

Basically, anywhere there's a classname (or ideally, method/property/etc.) in the API docs served by hub.html, it would be brilliant if it was an `` link to that class's documentation page. Right now, it's really difficult for someone not familiar with the framework to find the right page in the API docs, because I have to use the search tool just to figure out what package a class is contained in. If I could simply click the classname and go straight there, life would be much happier.

Contributor guide

Open the contributing guide

Research direction

The issue identifies hub.html as the app serving Aurelia documentation, but says its source could not be found open source. Start by locating the implementation that generates the API docs and determine whether class, method, and property references can be resolved to documentation pages. Done means relevant references throughout the served API docs link to their corresponding pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.