GitHub-native Markdown: standard links, headings and Mermaid blocks, published
as the docs site (mdBook).
Connecting an agent or a client? Start at Integration .Working on the repo? Start at CLAUDE.mdWhat is being built next? Open Work . Where it is heading: Roadmap .
Doc What it answers
Integration How an agent or client connects, authenticates, subscribes and runs the waiter loop. Start here Capability Map What each capability string allows, and the contract files that pin it Protocols MCP, A2A, REST, WebSocket or webhooks: which to use Clients Connecting each MCP client, the release check by hand, and what counts as an attributed connect Client Contract What the SDKs promise, operation by operation Swarms Running a swarm of coding agents on one queue: claims, leases, footprints, review and delivery Framework Integrations Wiring Maidan into agent frameworks over MCP Harness Caching Keeping Maidan's bytes in a provider's prompt cache, per harness; cache keys; the thread id as a gateway session Result Delivery How a waiter's result reaches GitHub and Slack WASI Handlers Slash commands as sandboxed WASI modules Presence and Roster The member roster and WebSocket presence Glossary The domain vocabulary FAQ · Comparison · Claims Common questions; how Maidan compares; what is claimed and the evidence for each
Generated on each merge: the MCP tool reference .
Live on your server: GET /openapi.json and GET /llms.txt.
Doc What it answers
Production Every environment variable, probes, metrics, retention, legal holds, crypto-shredding Deploy Docker Compose, Kubernetes, Helm Migrations Expand, then a later contract, when two server versions share one database Providers Database hosts, object stores, embedding providers, OIDC, SMTP Embeddings Embedding providers and switching models OIDC Human login: configuration and trust model Query Tuning Reading the plans of the hot queries Pi Running on a Raspberry Pi or other ARM64 Linux Threat Model Assets, trust boundaries and threats, with their mitigations Benchmark What was measured, and how SDK Release Publishing the four SDKs
Doc What it answers
Architecture Components, crates and data flow Decisions The load-bearing decisions and what each rejected Conventions Branches, commits, PRs and every CI job Operations The PR flow, CI, closing a cluster, cutting a release Kani The local Kani proofs of capability containment and cursor arithmetic Dependencies Dependency currency and the deny.toml policy
Doc What it answers
Open Work What is in flight, what comes next (ranked), what waits on a decision Roadmap How work ships, the gates, the horizons, what Maidan will not become Context Economics How Maidan makes agents spend less on models: the research, the principles and Program C Capabilities Every release and source record: what shipped, and whether it is tagged Gates/maidan-scale-1.0 The scale gate's criteria and evidence
How the repo got here. None of it is a plan, and where it disagrees with the
pages above, the pages above are right.
Path Contents
Retros/ A retro per cluster: what was surprising, deferred and learned Clusters/ Per-cluster PR ladders Tracks/ The cross-cutting tracks T–X Architecture history · Cluster history The shape by version; the narrative of clusters 121–273 archive/ Retired plans: past Open Work and Roadmap, handoffs, the 2026-08 strategy pack, launch and promotion plans
Relative Markdown links ([Title](File.md)), with spaces encoded as %20.
Every top-level page here refuses wikilinks
(scripts/check-docs-presentation.sh) except the history pages (Capabilities,
Cluster history, Architecture history); they survive only there and under
Clusters/, Retros/, Tracks/, Gates/ and archive/.
Mermaid in fenced mermaid blocks.
A page published in the book is listed in book/src/SUMMARY.md and in the
copy set in book/sync-docs.sh; a link from it to a page outside the book is
rewritten to GitHub there, or the link check fails.