Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC]: publish JSDoc source documentation #19

Open
3 tasks done
kgryte opened this issue Sep 4, 2021 · 1 comment
Open
3 tasks done

[RFC]: publish JSDoc source documentation #19

kgryte opened this issue Sep 4, 2021 · 1 comment

Comments

@kgryte
Copy link
Member

kgryte commented Sep 4, 2021

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

  • I have read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:.
@kgryte
Copy link
Member Author

kgryte commented Sep 9, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant