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 a cluster: merod, meroctl, the Ops API.
Protocol ReferenceYou want to know how a cluster works, and why.
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 groups its pages differently (The model, The call path, Trust, People & authority, Apps, Reference) because it is a sequence: it follows one call from a client’s sealed request to a committed log entry, then widens out.
Page conventions
Section titled “Page conventions”- Callouts.
:::noteis context,:::tipis a shortcut,:::cautionis a footgun. - Diagrams are animated — hit ▶ Replay to step through a flow again.
- Code blocks have a copy button; where a format matters (report data, receipts, key layouts) the page gives it exactly.
- Release candidate. Everything here is meant to match current code, which may still change; request and entry formats are not yet versioned. What is not done yet is named where it matters.
Two faster ways in
Section titled “Two faster ways in”Journeys by goalCurated cross-track paths: build an app, run a cluster, understand how it works.
Browse by topicEverything on replication, trust, access, apps, limits…