Skip to content

Consider Switching to typedoc for API documentation #695

@hasezoey

Description

@hasezoey

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsThis issue/pr is about documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions