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

documentation: integrate JSDoc & update readme #21

Open
hermet opened this issue Jun 2, 2024 · 0 comments
Open

documentation: integrate JSDoc & update readme #21

hermet opened this issue Jun 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hermet
Copy link
Member

hermet commented Jun 2, 2024

thinking removing API part from README and keeping Usage as our main guidance.
also considering JSDoc into https://www.thorvg.org/apis. so we can provide library users with main point of usage.

JSDoc

  • most starred API documentation tool in web dev
  • trusted by official typescript link
@hermet hermet added the documentation Improvements or additions to documentation label Jun 2, 2024
@hermet hermet mentioned this issue Jun 2, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
ThorVG.Web
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hermet