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 revamp #62

Open
psibean opened this issue Apr 9, 2024 · 0 comments
Open

Documentation revamp #62

psibean opened this issue Apr 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@psibean
Copy link
Contributor

psibean commented Apr 9, 2024

With various changes coming in v4, would also be nice to have some nicer / better organized documentation and maybe cut down on the overwhelming README such that it only highlights the most important things and links to relevant places to find more information.

Considering TSDoc based documentation generation where the static HTML output can be hosted via github pages.
@psibean psibean added the documentation Improvements or additions to documentation label Apr 9, 2024
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
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@psibean