README
¶
mecatl documentation
This is the documentation root — a short front door that routes each audience to
the right living guide. The full progressive reading map is in
READING.md — start there.
The coding-agent contract lives in ../AGENTS.md; this page does
not restate it.
Audience routes
| Audience | Route |
|---|---|
| Contributor / agent | READING.md → foundation spine (architecture → domain → ports → loop) → topic branches |
| Operator | ../README.md → public documentation → run mecated |
| Library consumer | Building on mecatl → engine/session → extension points → engine/COMPATIBILITY.md |
| API client developer | Drive via gRPC / HTTP → contracts/proto/mecatl/v1/ → gRPC reference or HTTP/SSE reference |
Nearby
READING.md— the full progressive reader map (contributor foundation spine, topic branches, and operator/library routes).architecture.md— the living architecture reference.- Public documentation — canonical user-facing guidance and reference.
adr/README.md— the frozen ADR index (the why archive).design/PRODUCTION-READINESS.md— the live shipped/deferred status tracker.- ADR 0215 — the landed,
experimental
openai-codexcapability and its private-backend boundary. - Agent Fabric Protocol — a draft, MCP-adjacent protocol for remote access to files, folders, and callable actions over HTTP; not yet implemented in mecatl.
Directories
Click to show internal directories.
Click to hide internal directories.