Documentation
What is documented, and what is not yet
There is no public documentation portal today. The documentation itself exists — around 200 pages of it — but it lives in a private repository, it is delivered with your install, and it has no rendered, versioned public site yet. Rather than link you to a portal that does not exist, here is the honest state of every part of it.
| Item | Status | What that means today |
|---|---|---|
| Deployment and operations runbooks | available | Written and complete. Delivered with your install; not on a public site. |
| Architecture reference | available | Written. Some runtime internals are still undocumented. |
| Product limitations and known gaps | available | Written and blunt. The best single source for what does not work yet. |
| HTTP API reference | available | The reference is generated from the hub's OpenAPI document at every release and carries the hub version. |
| Air-gapped install and upgrade runbooks | optional | Written, and only relevant if you choose the air-gapped deployment. Aimed at release engineers today, not at your operators. |
| Customer-facing self-host install guide | planned | Not written. The install tooling works and is tested; the guide an engineer outside Caldyr could follow does not exist yet. |
| Rendered, versioned public documentation portal | planned | Not built. No generator, no build step, no domain. This page is the placeholder until there is one. |
| Documentation in Russian, Spanish, Estonian and Finnish | in progress | Translated pages exist but lag the English and have not been re-checked since the English was consolidated. |
| Architecture decision records | planned | None exist. Decisions are recoverable from commit history, which is not the same thing. |
| Versioned security whitepaper | planned | Not written. The security page is an overview, not a whitepaper, and is labelled that way on purpose — there is no dated, versioned document to download. |
| API reference generated from a machine-readable schema | available | Built. The hub serves its OpenAPI document at /api/openapi.json with the hub version, and the reference page is rendered from it at every release. |
| Kubernetes and Helm deployment guide | research | Being looked at. There is no chart and no manifest set today; the supported shape is Docker Compose on a host. |
- API reference on the hub (sign in required)
- OpenAPI document (public, JSON)
- In-app user documentation on the hub (sign in required)
If you need any of the unwritten items to evaluate Caldyr, ask and we will send you what exists rather than tell you it is published.