Documentation Map
This page is the fastest way to find the right documentation path.
Start Paths
| Goal | Read First | Then Read |
|---|---|---|
| First local session | Getting Started | Troubleshooting |
| Linux host deployment | Linux and Wayland Support | Operations |
| Production control plane | Control Plane Deep Dive | Docker Control Plane, Security, Observability and Alerting |
| Linux operations hardening | Linux Production Playbook | Linux and Wayland Support, Runbooks and Checklists |
| Network/firewall planning | Network Ports and Firewall | Networking and Relay |
| Release and upgrade process | Versioning and Release Policy | Release Artifacts, Upgrade and Rollback |
| Licensing and commercial path | Deployment Modes | Pricing, FAQ |
| Engineering onboarding | Codebase Reference | Developer Workflows, Internal Design Docs |
| Runtime config hardening | Environment Variable Reference | Runtime and Service Reference, Security |
Full Docs Catalog
Core Concepts
Build and Integration
- Installation and Prerequisites
- Codebase Reference
- Runtime and Service Reference
- Control Plane Deep Dive
- Environment Variable Reference
- Developer Workflows
- Configuration Reference
- Desktop App
- Linux and Wayland Support
- Linux Production Playbook
- Internal Design Docs
Deploy and Operate
- Deployment Modes
- Docker Control Plane
- Network Ports and Firewall
- Observability and Alerting
- Versioning and Release Policy
- Security
- Operations
- Runbooks and Checklists
- Troubleshooting
- Release Artifacts
- Upgrade and Rollback
Planning
Suggested Reading Order for Teams
- Platform and product lead: Overview -> Deployment Modes -> Pricing
- Platform engineer: Getting Started -> Codebase Reference -> Developer Workflows
- Runtime engineer: Runtime and Service Reference -> Environment Variable Reference -> Configuration Reference
- Ops/SRE: Control Plane Deep Dive -> Docker Control Plane -> Runbooks and Checklists
- Security owner: Security -> Environment Variable Reference -> Troubleshooting