This directory contains the generated TypeDoc reference for the public APIs of
the Kalika TypeScript libraries. The reference is generated one package at a
time to avoid monorepo-wide TypeDoc heap pressure while still covering every
@kalika/* library entrypoint.
Generate#
pnpm kalika:api-reference
The generator discovers Kalika projects from libs/kalika/*/project.json, uses
each package's src/index.ts as the public entrypoint, and writes HTML to
docs/kalika/api-reference/generated/<package-slug>/.
Verify#
pnpm kalika:api-reference:check
The check confirms that every discovered Kalika package has a generated
index.html page and that the generated manifest exists.
Shared TypeDoc Policy#
All Kalika API reference packages use
typedoc.kalika.json:
- Private and
@internalAPIs are excluded. - Protected members remain visible for extension points.
- External dependency pages are excluded so the reference stays focused on Kalika-owned APIs.
- TypeScript error checking is skipped during documentation generation because this phase documents the public surface across packages that may have unrelated implementation type debt.
Package Coverage#
| Package | Public Entry Point | Generated Reference |
|---|---|---|
@kalika/algebra |
libs/kalika/algebra/src/index.ts |
generated/kalika__algebra/index.html |
@kalika/analysis |
libs/kalika/analysis/src/index.ts |
generated/kalika__analysis/index.html |
@kalika/category-theory |
libs/kalika/category-theory/src/index.ts |
generated/kalika__category-theory/index.html |
@kalika/citations |
libs/kalika/citations/src/index.ts |
generated/kalika__citations/index.html |
@kalika/combinatorics |
libs/kalika/combinatorics/src/index.ts |
generated/kalika__combinatorics/index.html |
@kalika/condensed-matter |
libs/kalika/condensed-matter/src/index.ts |
generated/kalika__condensed-matter/index.html |
@kalika/core |
libs/kalika/core/src/index.ts |
generated/kalika__core/index.html |
@kalika/cosmology |
libs/kalika/cosmology/src/index.ts |
generated/kalika__cosmology/index.html |
@kalika/database |
libs/kalika/database/src/index.ts |
generated/kalika__database/index.html |
@kalika/formal-verification |
libs/kalika/formal-verification/src/index.ts |
generated/kalika__formal-verification/index.html |
@kalika/general-relativity |
libs/kalika/general-relativity/src/index.ts |
generated/kalika__general-relativity/index.html |
@kalika/gravitational-waves |
libs/kalika/gravitational-waves/src/index.ts |
generated/kalika__gravitational-waves/index.html |
@kalika/hep-phenomenology |
libs/kalika/hep-phenomenology/src/index.ts |
generated/kalika__hep-phenomenology/index.html |
@kalika/hpc-orchestrator |
libs/kalika/hpc-orchestrator/src/index.ts |
generated/kalika__hpc-orchestrator/index.html |
@kalika/information-theory |
libs/kalika/information-theory/src/index.ts |
generated/kalika__information-theory/index.html |
@kalika/knowledge-graph |
libs/kalika/knowledge-graph/src/index.ts |
generated/kalika__knowledge-graph/index.html |
@kalika/lattice |
libs/kalika/lattice/src/index.ts |
generated/kalika__lattice/index.html |
@kalika/lie-theory |
libs/kalika/lie-theory/src/index.ts |
generated/kalika__lie-theory/index.html |
@kalika/neural-physics |
libs/kalika/neural-physics/src/index.ts |
generated/kalika__neural-physics/index.html |
@kalika/notebooks |
libs/kalika/notebooks/src/index.ts |
generated/kalika__notebooks/index.html |
@kalika/number-theory |
libs/kalika/number-theory/src/index.ts |
generated/kalika__number-theory/index.html |
@kalika/numerical |
libs/kalika/numerical/src/index.ts |
generated/kalika__numerical/index.html |
@kalika/probability |
libs/kalika/probability/src/index.ts |
generated/kalika__probability/index.html |
@kalika/quantum-field-theory |
libs/kalika/quantum-field-theory/src/index.ts |
generated/kalika__quantum-field-theory/index.html |
@kalika/quantum-gravity |
libs/kalika/quantum-gravity/src/index.ts |
generated/kalika__quantum-gravity/index.html |
@kalika/quantum-mechanics |
libs/kalika/quantum-mechanics/src/index.ts |
generated/kalika__quantum-mechanics/index.html |
@kalika/renderer |
libs/kalika/renderer/src/index.ts |
generated/kalika__renderer/index.html |
@kalika/research-agents |
libs/kalika/research-agents/src/index.ts |
generated/kalika__research-agents/index.html |
@kalika/sdk |
libs/kalika/sdk/src/index.ts |
generated/kalika__sdk/index.html |
@kalika/statistical-mechanics |
libs/kalika/statistical-mechanics/src/index.ts |
generated/kalika__statistical-mechanics/index.html |
@kalika/string-theory |
libs/kalika/string-theory/src/index.ts |
generated/kalika__string-theory/index.html |
@kalika/symbolic-regression |
libs/kalika/symbolic-regression/src/index.ts |
generated/kalika__symbolic-regression/index.html |
@kalika/tensor-networks |
libs/kalika/tensor-networks/src/index.ts |
generated/kalika__tensor-networks/index.html |
@kalika/topology |
libs/kalika/topology/src/index.ts |
generated/kalika__topology/index.html |
@kalika/typesetting |
libs/kalika/typesetting/src/index.ts |
generated/kalika__typesetting/index.html |
@kalika/utils |
libs/kalika/utils/src/index.ts |
generated/kalika__utils/index.html |
@kalika/numerical-engine is a Rust/Cargo workspace without a TypeScript
src/index.ts entrypoint, so it is intentionally outside this TypeDoc
generator.
Usage Examples#
See examples.md for task-oriented examples covering the major public functions and classes by package. The generated TypeDoc pages remain the source of truth for exact signatures, options, and return types.