Modelable Documentation
Start with the root README for the shortest installation and example path. The documentation set is intentionally small; each document has one role.
Use Modelable
- Getting started and migration: installation, editor setup, generated artifacts, and migration from existing schema formats.
- Language reference:
.mdlsyntax, types, projections, CEL, ownership, classification, and access metadata. - Tooling reference: CLI commands, LSP behavior, AI-assisted authoring, and development tooling.
- Compiler reference: emitters, generated artifacts, compatibility metadata, registry state, and distributed lineage.
- Sample scenarios:
worked
.mdlexamples.
Understand the Project
- Architecture and system specification: authoritative product concepts, invariants, and current/deferred boundaries.
- External integrations: shipped dbt/FHIR/ODCS drift workflows, local export targets, and non-committed integration research.
- Maintainer and agent guide: local gates, review policy, release process, and automation rules.
- Future direction and emitter extension overlays proposal: not-yet-accepted design candidates, tracked separately from the roadmap until promoted.
The roadmap covers product priorities, compiler correctness/capability slice detail, and repository-health/tooling gaps found by code/CI inspection, all in one document. It is directional — a deferred item is not committed until it has an issue and accepted design. Project-level policy remains in GOVERNANCE.md, CONTRIBUTING.md, and SECURITY.md.