Skip to content

Generated TypeDoc reference

The repository includes a TypeDoc configuration that reads the public entry points from the package source and generates a symbol-level HTML reference.

bash
npm run docs:api

Generated output is written to:

text
apps/docs/public/api-generated/

After generation, open /api-generated/index.html from the built documentation site.

The generated directory is intentionally not treated as the primary guide. Handwritten pages explain concepts and workflows; TypeDoc provides exact symbol signatures and source-linked details.

Released under the MIT License.