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

Consider Switching to typedoc for API documentation #695

Open
hasezoey opened this issue Sep 19, 2022 · 1 comment
Open

Consider Switching to typedoc for API documentation #695

hasezoey opened this issue Sep 19, 2022 · 1 comment
Labels
docs This issue/pr is about documentation

Comments

@hasezoey
Copy link
Collaborator

Currently all API documentation (config options, classes, enums, interfaces, types) are all done manually, but could be automated with typedoc documentation

testing typedoc branch: https://github.com/nodkz/mongodb-memory-server/tree/testTsDoc
run it with yarn run typedoc and then firefox typedoc_out/index.html (replace firefox with your browser of choice)
@hasezoey hasezoey added the docs This issue/pr is about documentation label Sep 19, 2022
@hasezoey hasezoey added this to the 9.0 milestone Sep 19, 2022
@hasezoey hasezoey removed this from the 9.0 milestone Aug 15, 2023
@hasezoey
Copy link
Collaborator Author

hasezoey commented Oct 5, 2023

updated branch testTsDoc to current website deploy scripts, integrated typedoc, but currently being blocked on facebook/docusaurus#9376

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs This issue/pr is about documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hasezoey