How to use these docs
These docs are split into four tracks by audience, and within each track the sidebar groups pages by what they’re for — so you can tell a “read in order” page from a “look it up” page at a glance.
Pick your track
Section titled “Pick your track”BuildYou're writing a Calimero app on the SDK.
OperateYou're running and configuring nodes.
Protocol ReferenceYou're reimplementing a node, or want the model.
ContributeYou're working on Calimero Core itself.
How each track is grouped
Section titled “How each track is grouped”Every track separates learning-oriented pages from reference:
| Group | What it is | How to read it |
|---|---|---|
| Get started | A tutorial path | In order, top to bottom |
| Guides / How-to | Task-focused recipes | Jump to the one you need |
| Reference | Exhaustive look-up | Search / scan, don’t read cover to cover |
| Deep dives | Implementation internals | When you want the “why” and the sharp edges |
The Protocol Reference adds a few more groups (The core model, The planes, Moving & reconciling, Subsystems) because it’s a sequence — it follows one operation from birth to convergence.
Page conventions
Section titled “Page conventions”- Callouts.
:::noteis context,:::tipis a shortcut,:::cautionis a footgun. In the Protocol spec, aNormativecaution marks a MUST/SHOULD requirement an independent implementation has to satisfy. - Diagrams are animated — hit ▶ Replay to step through a flow again.
- Code blocks have a copy button; spec sections give exact byte layouts.
- Pre-1.0. Everything here is accurate to current code but may change before 1.0; the byte-level details are versioned (see the spec’s versioning note).
Two faster ways in
Section titled “Two faster ways in”Journeys by goalCurated cross-track paths: build an app, run a fleet, reimplement a node.
Browse by topicEverything on CRDTs, encryption, performance, governance…