search

ably / ably-js

Javascript, Node, Typescript, React, React Native client library SDK for Ably realtime messaging service
https://ably.com/download
Apache License 2.0
316 stars 55 forks source link

Make a workflow to build a static API reference for the library #914

Open owenpearson opened 2 years ago

owenpearson commented 2 years ago

TSDoc is a good tool for this.

See https://github.com/ably/ably-asset-tracking-android/blob/main/.github/workflows/docs.yml for prior art.

┆Issue is synchronized with this Jira Task by Unito

VeskeR commented 5 months ago

I believe this is currently implemented using TypeDoc. See github action and static API reference for latest commit on main branch.

@owenpearson Would you be happy to close this issue?