ember-learn / ember-learn/ember-jsonapi-docs
Providing entire file github url in docs
- Dominant language
- JavaScript
- Stars
- 10
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
At present in the ember app we construct the github url of a file by checking its project name and the appending the partial file url from the docs we generate. This doesn't handle scenarios where the docs refers to classes such as rsvp, inflector which are ember libraries that are external dependencies for ember & ember-data. In such cases the file url is defined as `node_modules/rsvp/index.js` which will be broken when user accesses it.
We should handle these scenarios & update the docs with a full & functional github url so that the ember app can just provide the link to the user without any computation at its end.
Contributor guide
Assessment
This issue has not been assessed yet.