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

Provide TSDoc via GitHub Pages #152

Open
scripthunter7 opened this issue Mar 3, 2025 · 0 comments
Open

Provide TSDoc via GitHub Pages #152

scripthunter7 opened this issue Mar 3, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation Priority: P4 Status: In Progress

Comments

@scripthunter7
Copy link
Member

Currently, the libraries mostly have only their main functionalities documented in various README files. However, our TSDoc is pretty detailed everywhere, so it would be worthwhile to generate the documentation using a tool like TypeDoc and then deploy it to GitHub Pages, automatically updating it after every push to the master branch if needed. This way, we can provide comprehensive documentation for all libraries.

@scripthunter7 scripthunter7 added the documentation Improvements or additions to documentation label Mar 3, 2025
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 Priority: P4 Status: In Progress
Projects
None yet
Development

No branches or pull requests

3 participants