[RFC]: add support for adding links to API docs in the JSDoc
- Lenguaje dominante
- JavaScript
- Estrellas
- 6k
- Forks
- 1.3k
- Merge medio
- 1 d 3 h
- PR fusionados (30 d)
- 611
Descripción
### 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:`.
Guía de contribución
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100