[RFC]: add support for adding links to API docs in the JSDoc
Open
difficulty: 4
Documentation
Needs Discussion
RFC
Tools
TypeScript
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 1.3k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 611
Description
### Description
This RFC proposes linking to the API docs directly from the JSDoc allowing users to easily open up the full docs through the IntelliSense overlays in IDEs
This would have to be automated as the URL might change and is prone to human errors if manually done.
### Related Issues
No.
### Questions
No.
### Other
No.
### Checklist
- [X] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [X] Searched for existing issues and pull requests.
- [X] The issue name begins with `RFC:`.
Contributor guide
Assessment
This issue has not been assessed yet.