Modelable Documentation
Start with the root README for the shortest installation and example path. Each current document has one role.
Use Modelable
- Getting started and migration: installation, editor setup, generated artifacts, typed semantic facets, 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.
- Emitter extension overlays: accepted target-specific representation model.
- External integrations: shipped integration workflows and non-committed integration research.
- Maintainer and agent guide: local gates, review policy, release process, and automation rules.
- Roadmap: the single forward-looking product plan.
Historical material
Completed or superseded planning material is intentionally kept out of normal navigation:
Archived implementation plans and design specifications remain in the repository's internal agent-workflow directory and are not part of the public documentation set.
Historical checkboxes and priorities are non-authoritative. Current support
status comes from implementation/tests and modelable capabilities; current
future work comes only from ROADMAP.md.
Project-level policy remains in GOVERNANCE.md, CONTRIBUTING.md, and SECURITY.md.