Skip to content

CVNTrade — Documentation

Single source of truth for the CVNTrade platform: the Design System that ties needs → epics → stories → designs → ADRs → PRs → pipeline runs → model versions → releases into one traceable spine.

Start here

By role

You are… Start with
A new contributor Blueprint → ADR index → Operations §Dev environment
Debugging a pipeline run ADRs §Observability (30-38) → Operations §Runbooks
Proposing a design change Templates → Design doc → ADR if invariants shift
Operating the cluster Operations → ADRs §Infra (1, 3, 12, 13)

Repo structure

Everything ships from the documentation/ folder:

documentation/
├── DESIGN_SYSTEM_BLUEPRINT.md     ← you want to read this
├── needs/                          ← CVN-N* — product needs (populated by audit PR)
├── epics/                          ← CVN-N*-E* — epic breakdowns
├── stories/                        ← CVN-N*-US* — user stories
├── design/                         ← one per need, split decisions into ADRs
├── adr/                            ← 63 ADRs, migrated Phase 0
├── architecture/                   ← Structurizr DSL workspace + diagrams
├── releases/                       ← CVN-R* — auto-generated release notes
├── templates/                      ← 6 templates (need / epic / story / design / adr / release)
└── runbooks/                       ← on-call runbooks

How this site is built

  • Tool: MkDocs + Material theme
  • Source: documentation/ in the repo
  • Build: mkdocs build --strict — broken links fail the build
  • Deploy: GitHub Actions on push to main → GitHub Pages → docs.cvntrade.eu
  • Local preview: mkdocs serve on port 8000 — see Operations §Working with the docs site
  • CVNTrade on GitHub
  • Issue #593 — Design System umbrella
  • OpenProject (product source of truth) — openproject.cvntrade.eu (Phase 1)
  • Grafana (observability single entry point — ADR-26) — grafana.cvntrade.eu