Skip to main content

TypeScript API reference

Placeholder

TypeDoc is not yet configured for the frontend packages. This page will be populated when TypeDoc is added to frontend/packages/ui/.

To enable:

  1. Add to frontend/packages/ui/: pnpm add -D typedoc
  2. Create typedoc.json config
  3. Run: npx typedoc --out docs/ src/

Setup instructions

// frontend/packages/ui/typedoc.json
{
"entryPoints": ["src/index.ts"],
"out": "docs",
"plugin": ["typedoc-plugin-markdown"],
"theme": "markdown"
}

Key modules

When generated, the reference will cover:

ModulePurpose
@aucert/uiShared UI component library (shadcn/ui based)
console/features/test-runsTest run management UI
console/features/bugsBug tracking UI
console/features/overviewDashboard overview
console/apiAPI client functions