Skip to content

Add automated documentation generation #7

@thibaudcolas

Description

@thibaudcolas

At the moment, the project's documentation is limited to what is in the README. It would be nice if there was more complete documentation generated automatically: a full API reference, with links back to the source code, based on the Flow types (or JSDoc).

Ideally this would be generating Markdown so it can be versioned with the code in Git/GitHub.

Tools to consider & useful info:

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions