Welcome to the Kroki-rs Developer Guide. This documentation is organized into categories to help you navigate the system’s architecture, development workflows, and operational practices.
🚀 Getting Started¶
Quick Start: Setup your environment and make your first contribution.
Contributing: Community guidelines and PR process.
🏗️ Design & Architecture¶
Architecture Overview: Philosophical tenets and high-level flow.
Providers & Dependencies: The Provider Pattern and system dependency map (JRE/Ditaa).
Browser Rendering: Headless Chromium strategy and font management.
Design Decisions (ADRs): Records of critical architectural choices.
🛠️ Development Workflow¶
Kroki-Flow: Git branching, PR gates, and verification phases.
Local Development: The
dflowCLI and resource optimization.Coding Standards: Rust conventions, error handling, and MyST linking rules.
🌐 Infrastructure & CI/CD¶
Infrastructure Overview: Architecture, philosophy, and environmental drift.
Development Environment: Local setup, Podman, and the dflow toolsuite.
Automation & Pipelines: CI workflows, sccache, and distribution.
Packaging & Distribution: Homebrew, GHCR, and binary distribution.
🩺 Operations & Maintenance¶
Observability: Tracing, Metrics, and the Admin Dashboard.
Troubleshooting: Common pitfalls and debugging strategies.
🗺️ Project Roadmap¶
Roadmap: Strategic project direction.
Technical Debt: Living record of remediation items.
📚 Resources¶
References: Standards, External Docs, and Glossary.