stdlib-js / stdlib-js/stdlib

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

Offen
#2,560 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
difficulty: 4 Documentation Needs Discussion RFC Tools TypeScript
Vorherrschende Sprache
JavaScript
Sterne
6k
Forks
1.3k
Ø Merge
1 T. 3 Std.
Gemergte PRs (30 T.)
611

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.