mongodb-memory-server icon indicating copy to clipboard operation
mongodb-memory-server copied to clipboard

Published 20 hours ago • verified publisher icon nodkz

Consider Switching to typedoc for API documentation

Open hasezoey opened this issue 3 years ago • 2 comments

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 avatar Sep 19 '22 10:09 hasezoey

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

hasezoey avatar Oct 05 '23 16:10 hasezoey

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.

hasezoey avatar Jun 08 '24 10:06 hasezoey