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.

Sign up for GitHub

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

Jump to bottom

Auto generate typedocs #67

Open
kirangadhave opened this issue Apr 11, 2024 · 0 comments
Open

Auto generate typedocs #67

kirangadhave opened this issue Apr 11, 2024 · 0 comments

Comments

@kirangadhave
Copy link
Member

kirangadhave commented Apr 11, 2024 •
edited
Loading

The TrrackJS docs page has usage examples and some conceptual explanations. We need an API + Types reference auto-generated from the code using typedoc or something similar.

@JackWilb @bbollen23 will appreciate any input on this. I have used typedoc earlier, and most of the code has JSDoc-style comments.
@kirangadhave kirangadhave changed the title Review and update documentation. Auto generate typedocs Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kirangadhave