docs(okf): write overview, architecture, decisions and roadmap

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Noel SabiaandClaude Opus 5.5 committed 2026-10-11 14:18:32 +02:00
1 parent 987a5efba1
commit 557ac1985b
20 files changed
+750 -16

No files matched your search

+8 -16
View File
@@ -2,22 +2,14 @@
okf_version: "0.2"
---
# Project
# Start here
* [Overview](overview.md) - Interactive CV on k3s: falling down and standing up again, shown live.
* [Roadmap](roadmap.md) - What ships in v1, v2 and v3, including the in-browser language model.
* [Overview](overview.md) - A CV whose life chapters run as real Kubernetes workloads that visitors can knock down and watch recover.
* [Roadmap](roadmap.md) - Small releases in three phases, each a few days of work at most, each ending in something that runs.
* [Update log](log.md) - History of changes to this bundle.
# Architecture
# Drill down
* [System](architecture/system.md) - Cloudflare Tunnel, Go gateway serving the static Nuxt build, chapter services in namespace `cv`.
* [Chapter service](architecture/chapter-service.md) - One Go image, health behavior set by `MODE`, knockdown via `/fall`.
* [Gateway](architecture/gateway.md) - Only public API: SSE pod states and rate-limited `/fall`.
* [Delivery](architecture/delivery.md) - Gitea Actions: Snyk, build, Gitea registry, `kubectl apply -k`, release-please.
# Decisions
* [Decisions](decisions/) - Accepted trade-offs, such as v1 accepting home-server downtime.
# Chapters
* [Chapters](chapters/) - One concept per life chapter and its Kubernetes state.
* [Architecture](architecture/) - Components, services, frontend, delivery, and the in-browser language model.
* [Decisions](decisions/) - What we chose, what we cut, and what is still open.
* [Chapters](chapters/) - How Kubernetes states map to life chapters, and later one concept per chapter.