[RFC]: add support for adding links to API docs in the JSDoc
- Ngôn ngữ chính
- JavaScript
- Star
- 6k
- Fork
- 1.3k
- Merge trung bình
- 1 ngày 3 giờ
- Pull request đã merge (30 ngày)
- 611
Mô tả
### 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:`.
Hướng dẫn đóng góp
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript
- Lĩnh vực
- documentation
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100