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

[chore] Use typedoc for API docs #424

Closed
LeaVerou opened this issue Feb 11, 2024 · 2 comments
Closed

[chore] Use typedoc for API docs #424

LeaVerou opened this issue Feb 11, 2024 · 2 comments
Labels
Topic: Documentation Improvements or additions to documentation

Comments

@LeaVerou
Copy link
Member

Our /api docs are currently a total mess because they are not being updated. Instead, the only docs we really have are those under /docs. We also need proper low level API docs.

I’ve recently started using typedoc in other projects and it seems to work better than any of the others I’ve tried from time to time.

@LeaVerou LeaVerou added the Topic: Documentation Improvements or additions to documentation label Feb 11, 2024
@MysteryBlokHed
Copy link
Member

Before switching over, more detailed doc comments should probably be added to the types since many functions/properties are undocumented. The docs could probably just be copy+pasted from the current API page for the most part

@LeaVerou
Copy link
Member Author

Just pushed a first stab at this, since our API docs were preposterous. Lots of room for improvement though if someone wants to experiment with the settings!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Topic: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants