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

Generate documentation from TypeScript and code comments #4

Open
suchipi opened this issue Jan 25, 2020 · 0 comments
Open

Generate documentation from TypeScript and code comments #4

suchipi opened this issue Jan 25, 2020 · 0 comments
Labels
build Related to how the packages are built documentation Improvements or additions to documentation

Comments

@suchipi
Copy link
Owner

suchipi commented Jan 25, 2020

The documentation for @hex-engine/core and @hex-engine/2d is written by hand right now, and as we continue to work on things it'll be easy for it to get out of sync with the codebase. It'd be better long-term to generate it using typedoc or something.
@suchipi suchipi added documentation Improvements or additions to documentation 2d Related to @hex-engine/2d core Related to @hex-engine/core build Related to how the packages are built and removed 2d Related to @hex-engine/2d core Related to @hex-engine/core labels Jan 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
build Related to how the packages are built documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@suchipi