Consider Switching to typedoc for API documentation

typegoose / mongodb-memory-server

Manage & spin up mongodb server binaries with zero(or slight) configuration for tests.

https://typegoose.github.io/mongodb-memory-server/

MIT License

2.55k stars 185 forks source link

Consider Switching to typedoc for API documentation #695

Open hasezoey opened 1 year ago

hasezoey commented 1 year ago

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 commented 10 months ago

updated branch testTsDoc to current website deploy scripts, integrated typedoc, but currently being blocked on https://github.com/facebook/docusaurus/discussions/9376

hasezoey commented 2 months ago

i dont know why i didnt update this again, but there is typedoc being generated since 8.16.0 (e0c0bc85bf31dce018ffac5c66de6d1c79921f9b).

though i will keep this issue open as the old API documentation should be moved, at least the parts that are redundant.