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

Use TypeDoc for Documentation Generation #48

Open
threeal opened this issue Aug 11, 2023 · 0 comments
Open

Use TypeDoc for Documentation Generation #48

threeal opened this issue Aug 11, 2023 · 0 comments
Labels
docs
Milestone
Version 0.4.0

Comments

@threeal
Copy link
Owner

threeal commented Aug 11, 2023

This issue proposes the adoption of TypeDoc to generate documentation from the comments present in the TypeScript source files. TypeDoc will allow us to automatically create comprehensive and well-structured documentation based on the inline comments within the codebase. By using TypeDoc, we can streamline the process of documenting our TypeScript project, making it easier for developers to understand the code and its API.
@threeal threeal added the docs label Aug 11, 2023
@threeal threeal added this to the Google Rank v0.3.0 milestone Aug 11, 2023
@threeal threeal modified the milestones: Version v0.3.0, Version 0.4.0 Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
Node.js Projects
Status: Todo
Milestone
Version 0.4.0
Development

No branches or pull requests
1 participant
@threeal