API Coverage
Automated public export coverage for reference docs.
This page records the coverage policy that keeps handwritten reference pages aligned with public package exports.
Scope
The coverage check treats every package entry in package.json#exports as a public import path. It uses the TypeScript compiler to enumerate symbols exported from those entrypoints, then verifies that the mapped reference docs mention each import path and exported symbol.
Internal source-file exports are outside this check unless they are re-exported by a package entrypoint.
Current Coverage
| Package | Public entrypoints | Public exports | Reference coverage |
|---|---|---|---|
@anvia/core | 19 | 250 | Core |
@anvia/openai | 1 | 17 | OpenAI Provider |
@anvia/gemini | 1 | 13 | Gemini Provider |
@anvia/anthropic | 1 | 4 | Anthropic Provider |
@anvia/mistral | 1 | 10 | Mistral Provider |
@anvia/fastembed | 1 | 6 | FastEmbed |
@anvia/transformers | 1 | 6 | Transformers |
@anvia/chroma | 1 | 4 | Chroma |
@anvia/pgvector | 1 | 6 | pgvector |
@anvia/qdrant | 1 | 5 | Qdrant |
@anvia/langfuse | 1 | 6 | Langfuse |
@anvia/otel | 1 | 3 | OpenTelemetry |
@anvia/studio | 1 | 61 | Studio |
The check must report:
TOTAL_MISSING_ENTRYPOINTS=0 TOTAL_MISSING_EXPORTS=0Re-run Check
Run this from the repository root:
pnpm docs:reference-checkpnpm docs:typecheck also runs the same check before MDX generation and TypeScript validation.
Documentation Standard
Each practical reference page should document the public surface with:
| Requirement | Expected content |
|---|---|
| Import source | Package or subpath imports, such as @anvia/core/memory |
| Signature | TypeScript class, function, interface, type, or constant shape |
| Purpose | What the primitive owns or represents |
| Return behavior | Resolved value, emitted events, side effects, or type-only behavior |
| Notable errors | Validation, provider, transport, persistence, or capability failures |
| Example | Minimal code showing ordinary use when the primitive is runtime-facing |
| Related docs | Guides or cookbook entries for workflow-oriented usage |