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

Automate documentation generation from JSDoc comments #67

Open
SippinOnJuiceBox opened this issue Sep 24, 2024 · 0 comments
Open

Automate documentation generation from JSDoc comments #67

SippinOnJuiceBox opened this issue Sep 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@SippinOnJuiceBox
Copy link
Collaborator

Set up Docusaurus (because it looks nice) or any other docgen to generate documentation from our existing JSDoc comments.

Acceptance Criteria:

  • Successfully generate documentation from JSDoc comments
  • Documentation site builds and serves without errors
  • All existing components with JSDoc comments are included in the generated docs
@SippinOnJuiceBox SippinOnJuiceBox added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant