[RFC]: add support for adding links to API docs in the JSDoc

stdlib-js / stdlib

✨ Standard library for JavaScript and Node.js. ✨

https://stdlib.io

Apache License 2.0

4.34k stars 440 forks source link

[RFC]: add support for adding links to API docs in the JSDoc #2560

Open Snehil-Shah opened 2 months ago

Snehil-Shah commented 2 months ago

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.
[X] Searched for existing issues and pull requests.
[X] The issue name begins with RFC:.

AbhinavKRN commented 2 months ago

hey @kgryte , can you assign this issue to me!

kgryte commented 2 months ago

@AbhinavKRN Thanks for volunteering to work on this. However, I am not sure how this would work and what would be involved.

Before doing any coding on this, I suggest first doing some R&D and making a proposal on this RFC regarding how you plan to implement a solution. That upfront design will help reduce the design space and allow us to iterate a bit before committing to a technical approach and hopefully help reduce wasted effort.

AbhinavKRN commented 2 months ago

Sure @kgryte , on it.