You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This RFC proposes publishing the JSDoc source documentation.
Currently, we publish the TypeScript declarations and do not publish the JSDoc source documentation.
While the TypeScript documentation is useful, especially for those using TypeScript, the JSDoc source documentation provides a much richer set of types, examples, notes, and implementation details.
In order to publish JSDoc source documentation, we're likely to need to write our own documentation generator. The original jsdoc package was not well-suited to "modern" JS development (e.g., modules, packages, etc) last time I checked.
Description
This RFC proposes publishing the JSDoc source documentation.
Currently, we publish the TypeScript declarations and do not publish the JSDoc source documentation.
While the TypeScript documentation is useful, especially for those using TypeScript, the JSDoc source documentation provides a much richer set of types, examples, notes, and implementation details.
Related Issues
No.
Questions
No.
Other
No.
Checklist
RFC:
.The text was updated successfully, but these errors were encountered: