Dory Documentation¶
Unified documentation portal for the Dory platform — a system for running stateful, fault-tolerant processors on Kubernetes with zero-downtime migration, automatic state persistence, and edge↔cloud failover.
Sections¶
| Section | What's inside |
|---|---|
| System | Platform overview, end-to-end architecture, and a shared glossary. |
| Guides | Platform-level onboarding (subscribing to events, publishing a processor template). |
| Processor SDK | Build stateful processors in Python: lifecycle, state, resilience, observability, edge, output, configuration, API. |
| Orchestrator | The Go control plane: pod lifecycle, state migration, edge failover, configuration, API, metrics, deployment. |
| Reference | The runtime_config_template field reference. |
| Diagrams | Architecture and approach diagrams (SVG/PNG, slide-ready). |
New here?¶
- Operators running the platform → start with the Orchestrator.
- Developers building processors → start with the Processor SDK.
- Everyone → skim the Core Concepts & Glossary.
Contributing docs
This site is structure-driven: the folder tree under docs/ is the navigation.
To add or edit a page, drop a Markdown file in the right section folder and open a
pull request — a merge to main publishes the site automatically. See the repo
README.md for the full contributor guide.