Skip to main content

​
Two layers of reference

This documentation site is the practical reference layer. Use the pages in this section when you want:
  • the right public entry point
  • the intended mental model
  • grouped API surfaces
  • examples that match how the framework is meant to be used
The repository also ships a generated TypeDoc site in /docs. That is the exhaustive signature layer. Use TypeDoc when you need:
  • every exported class and type
  • low-level manager signatures
  • enums, variables, and interface shapes
  • a complete exported surface map

​
Start here in Mintlify

​
TypeDoc entry points

The generated TypeDoc site lives alongside the repository under /docs/:
  • /docs/index.html — TypeDoc index
  • /docs/modules.html — Modules
Use the Mintlify docs for:
  • concepts
  • design intent
  • recommended patterns
  • end-to-end guides
  • high-level API discovery
Use TypeDoc for:
  • exact signatures
  • full type members
  • every exported symbol
That split keeps the production docs readable without hiding the full exported surface from advanced users.
Last modified on June 13, 2026