How this documentation is organized
This documentation is organized with the Diátaxis framework. Diátaxis observes that technical documentation serves four distinct needs, and that mixing them makes docs worse for everyone. So the top of the sidebar is four modes, not a list of product features:
| Mode | Orientation | Answers | When you are… |
|---|---|---|---|
| Tutorials | learning | ”Take me from nothing to a working result.” | new, and want to learn by doing |
| How-to guides | a task | ”How do I accomplish this specific thing?“ | working, and need a recipe |
| Reference | information | ”What exactly are the API, events, modules, flags?“ | building against it, and need precision |
| Explanation | understanding | ”Why is it built this way?“ | evaluating, and want the reasoning |
A quick map of where things live:
- Tutorials — the learning paths: from zero to a read/write access graph, and getting started per real scenario — single node, Docker Compose, Kubernetes, air-gapped.
- How-to guides — install & operate (self-host, backup & restore, monitoring, troubleshooting), the per-connector guides (pgAudit, CloudTrail, eBPF, Claude Code, MCP, identity), and the cookbook of governance recipes (deny-closed policies, budgets, approvals, drift triage, the kill switch, SIEM push).
- Reference — the REST API (rendered from the product’s own OpenAPI 3.1 contract), the API stability policy, the event bus (an AsyncAPI 3.0 contract), the modules catalog, the CLI and configuration.
- Explanation — the architecture, the security model and threat model, the open-core licensing.
Conventions
Section titled “Conventions”- Search is local and client-side (Pagefind). It runs entirely in your browser; nothing is sent to an external search service — consistent with the product’s self-hosted design, where what crosses your perimeter is what you configure to cross it.
- Versioned. The documentation is versioned: when a new product version ships, the docs for the previous one are preserved. The version selector lives in the top bar.
- Honest about limits. Where a capability is design-stage, post-v1, or simply not built yet, the docs say so plainly. See Honesty & limits. Tutorial and how-to commands are meant to be run as written.
- Languages. The canonical documentation is in English; translations are available in Spanish, Simplified Chinese, Russian, Japanese, German and French (machine-translated, English-authoritative, falling back to English where not yet translated).