From 2f102a1a5e0dc47797eef9f6b9eee79e24d26d56 Mon Sep 17 00:00:00 2001 From: Asger Geel Weirsoee Date: Fri, 27 Feb 2026 12:33:08 +0100 Subject: [PATCH] Move project docs to repo wiki and keep docs folder minimal --- docs/ARCHITECTURE.md | 27 --------------------------- docs/QUALITY_GATES.md | 17 ----------------- docs/README.md | 8 ++++++++ 3 files changed, 8 insertions(+), 44 deletions(-) delete mode 100644 docs/ARCHITECTURE.md delete mode 100644 docs/QUALITY_GATES.md create mode 100644 docs/README.md diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md deleted file mode 100644 index 6d57ec6..0000000 --- a/docs/ARCHITECTURE.md +++ /dev/null @@ -1,27 +0,0 @@ -# Arkitektur (MVP) - -## Moduler -- `core_admin`: global drift/admin, health, valideringer -- `lobby`: session creation/join, player presence -- `fupogfakta`: game rules, rounds, scoring (spil 1) -- `realtime`: websocket events + state sync -- `voice`: fælles voice-acting/TTS interface - -## Auth & sessions -- Login (username/password) kræves for at oprette/hoste spil -- Deltagelse i kørende spil sker via session-kode - -## Voice-acting (platformkrav) -- Alle spil skal kunne afspille voice lines via fælles interface -- Voice er modulært pr. spil (ikke hardcoded) - -## Realtidsmodel -- Host-screen og mobilklienter forbinder via websocket -- Autoritativ game state ligger server-side -- Klienter sender intents (`submit_lie`, `submit_guess`) -- Server broadcaster state transitions - -## Datamodel-principper -- Score beregnes server-side -- Hver scoreændring gemmes i `ScoreEvent` -- Runde-konfiguration gemmes per session (points ikke hardcoded) diff --git a/docs/QUALITY_GATES.md b/docs/QUALITY_GATES.md deleted file mode 100644 index aabd0e9..0000000 --- a/docs/QUALITY_GATES.md +++ /dev/null @@ -1,17 +0,0 @@ -# Quality gates (mål) - -## Merge til main kræver -1. Alle tests grønne -2. Test coverage >= 70% -3. Lint/format/type checks grønne - -## Planlagte checks -- pytest + pytest-cov (coverage XML + summary) -- ruff (lint) -- black --check (format) -- mypy (type checks, gradvis indfasning) - -## Enforcement i Gitea -- Branch protection på main -- Kræv successful checks fra CI-workflow før merge -- Kræv mindst 1 review (kan justeres) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..b679555 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,8 @@ +# Documentation moved to Wiki + +Projekt-dokumentation vedligeholdes i repo-wiki: + +- Wiki repo: `weirsoe-party-protocol.wiki` +- Gitea wiki URL: `https://gitea.weircon.dk/wpp/weirsoe-party-protocol/wiki` + +Denne `docs/` mappe holdes minimal fremover.