Skip to content

Generate and publish API documentation #1532

@robertknight

Description

@robertknight

https://patterns.hypothes.is currently includes manually created pages describing individual components. However this is not a comprehensive API reference. Publishing API docs would make it possible to link to them in discussions and from the guide pages. I've used TypeDoc for this before, but there might be other tools worth looking at.

Slack thread: https://hypothes-is.slack.com/archives/C1M8NH76X/p1713959531923039

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions