-
Notifications
You must be signed in to change notification settings - Fork 22
docs: publish TypeDoc API reference on release, with multi-version support #399
Copy link
Copy link
Open
Description
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
- Ensure all exported types, functions, classes, and interfaces have TSDoc comments
- Add TypeDoc config (
typedoc.jsonortypedocfield inpackage.json) - Add a GitHub Actions workflow step to build and publish docs on each release tag
- Host versioned docs (e.g. GitHub Pages, preserving old versions per tag)
- Link to hosted docs from the README
References
- TypeDoc: https://typedoc.org
- typedoc-plugin-versions: https://citkane.github.io/typedoc-plugin-versions/
- Example: https://bitcoinjs-lib.github.io (if available)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels