Calimero Docs

Official documentation site for the Calimero network, built with Astro Starlight.

Live at docs.calimero.network

Contents

• Start here — the home page (what Calimero is, two lines to a local cluster) and the quickstart: run a node, clone the example app, build, deploy, call
• Guide, one path in order — 1. the example (the KV Store) line by line, 2. calling it from code (mero-js, Python, Rust, meroctl), 3. packaging and publishing to the registry, 4. deploying on Calimero Cloud and installing on a node from the registry
• Concepts — how Calimero works, what an app sees on a cluster, organizations and access
• Security — verifying a cluster, the security model and attestation
• Reference — glossary, and links to the core reference for the protocol, the full SDK and running nodes

Local development

npm install
npm run dev        # dev server at localhost:4321
npm run build      # production build to ./dist
npm run preview    # preview production build locally

Project structure

src/
├── assets/          # images and icons
├── components/      # the home hero and the diagrams (Flow, ClusterDiagram, EndToEnd, OrgDiagram, ...)
├── content/
│   └── docs/        # all documentation pages (.md)
├── pages/           # custom pages (e.g. 404)
└── styles/          # global CSS overrides
astro.config.mjs     # Starlight config, sidebar, and nav

Contributing

All docs live as MDX files under src/content/docs/. To add or edit a page:

1. Create or edit a .mdx file in the relevant section folder
2. Add it to the sidebar in astro.config.mjs if it's a new page
3. Run npm run dev to preview locally
4. Open a pull request

Built with

• Astro
• Starlight

Design

The site uses the calimero.network landing's design: paper and ink with one seal red, Inter Tight and JetBrains Mono, hairline rules and square corners, in light and dark. The tokens are in src/styles/calimero.css, mapped onto Starlight's --sl-color-* scale. Diagrams are Astro components drawn from the same tokens, so they follow the theme; use Flow for a sequence of steps rather than an image or a diagram library.