About the API reference
The API reference for @sparkletree/core
and @sparkletree/react is
generated from the TSDoc in the SDK source (core/src/index.ts and
react/src/index.ts) with starlight-typedoc,
so it is always as current as the code it documents.
Generation is on by default: a normal build from the monorepo root includes the package pages in the sidebar:
pnpm installpnpm --filter @sparkletree/docs-site buildNo core/dist or react/dist build is required first.
docs-site/typedoc.tsconfig.react.json maps @sparkletree/core onto its source
entry point, and the core tsconfig documents the source tree directly. If you are
reading this page on the published site and see no package pages in the sidebar,
the site was built with the escape hatch (STARLIGHT_TYPEDOC=0, for checkouts
where the sdk workspace is not installed).
The prose API documentation is complete and hand-written either way:
- Provider, components & useIsland:
SparkletreeProvider,Hero,Cta,useIsland,StreamText. - Using it without React:
openStream,createClient, and the obligations React was handling for you.