Summary
Set up automated API reference documentation for the TypeScript SDK, built with TypeDoc and published on every release with multi-version variants preserved.
Motivation
The TS SDK is a library intended for external developers. Having browsable, versioned API docs (equivalent to godoc / docs.rs) makes the SDK easier to adopt.
Suggested approach
- TypeDoc — generates API docs from TSDoc comments, outputs static HTML
- Host on GitHub Pages with per-version paths (e.g.
/docs/v1.2.0/) or use a versioning plugin
Requirements
References
Summary
Set up automated API reference documentation for the TypeScript SDK, built with TypeDoc and published on every release with multi-version variants preserved.
Motivation
The TS SDK is a library intended for external developers. Having browsable, versioned API docs (equivalent to godoc / docs.rs) makes the SDK easier to adopt.
Suggested approach
/docs/v1.2.0/) or use a versioning pluginRequirements
typedoc.jsonortypedocfield inpackage.json)References