[RFC]: add support for adding links to API docs in the JSDoc
- 主要言語
- JavaScript
- スター
- 6k
- フォーク
- 1.3k
- 平均マージ
- 1日 3時間
- マージ済み PR(30日)
- 611
説明
### 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:`.
コントリビューションガイド
調査の方向性
The issue proposes automated links from JSDoc to API documentation for IntelliSense overlays, but it names no files, tests, or entry points. First determine how the JSDoc and API documentation URLs are generated; done should include a defined automation approach and verified links that open the corresponding API docs.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100