Skip to content
Umi Docs

Umi documentation

The home for everything written about Umi: how the system is built, the decisions behind it, and how to work on it.

Every page is a Markdown file under src/content/docs/, organised by the Diátaxis modes (tutorials, how-to, reference, explanation) and rendered with Astro Starlight.

Explanation — understanding the system

Section titled “Explanation — understanding the system”

The confirmed design decisions live here.

  • Umi is an OS; silos are apps — the north-star model, and why the security boundary is the plugin boundary.
  • Inference — the local-first guarantee, why llama.cpp as a managed sidecar, and the engine seam that keeps WebGPU/NPU open.
  • One API surface — a single capability-gated service API; axum is the unified external door for remote devices and silos.
  • The silo contract — how a silo declares itself, talks to core, and is sandboxed (manifest + WIT + MCP + capabilities).
  • Umi conventions — naming, identifiers, and the silo.toml shape.

Tutorials · How-to · Reference

Section titled “Tutorials · How-to · Reference”

Scaffolded and waiting to be written.

The backend design scratchpad (/scratchpad/umi-backend.md) is working thinking, not published docs — confirmed decisions graduate from it into Explanation above.