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:
- Add to
frontend/packages/ui/:pnpm add -D typedoc - Create
typedoc.jsonconfig - 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:
| Module | Purpose |
|---|---|
@aucert/ui | Shared UI component library (shadcn/ui based) |
console/features/test-runs | Test run management UI |
console/features/bugs | Bug tracking UI |
console/features/overview | Dashboard overview |
console/api | API client functions |