Kionga engineering handbook¶
This handbook explains how Kionga is designed and built. It is written for people who change Kionga's code: contributors, maintainers and reviewers. To install, use or operate Kionga, read the product documentation.
| Section | What it covers | Standard |
|---|---|---|
| Architecture | Goals, constraints, context, building blocks, runtime and deployment views, crosscutting concepts, quality, risks | arc42 |
| Components | Each repository and service: responsibility, interfaces, configuration, code map, tests | One shape per page |
| Contracts | Interfaces between the control plane, its clients and its workers | |
| Decisions | Why major technical choices were made | MADR 4 |
| Contributing | Workspace setup, tests, CI gates, commits, and the documentation standard | |
| Status and plans | What is implemented, verified, or planned |
Start with architecture for the big picture, or with contributing to make your first change.
Every component repository also carries a README.md, a CONTRIBUTING.md
(development setup, tests, release) and an ARCHITECTURE.md (a map of its code).