Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate and publish API documentation #1532

Open
robertknight opened this issue Apr 24, 2024 · 0 comments
Open

Generate and publish API documentation #1532

robertknight opened this issue Apr 24, 2024 · 0 comments

Comments

@robertknight
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant