stdlib-js / stdlib-js/stdlib

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

Ouverte
#2,560 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
difficulty: 4 Documentation Needs Discussion RFC Tools TypeScript
Langage dominant
JavaScript
Étoiles
6k
Forks
1.3k
Merge moyen
1 j 3 h
PR mergées (30 j)
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

![image](https://github.com/stdlib-js/stdlib/assets/130062020/c5e8583b-61a9-482e-b641-7c54ce9b9b21)

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:`.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.