Move project docs to repo wiki and keep docs folder minimal
Some checks failed
CI / test-and-quality (push) Failing after 10s
Some checks failed
CI / test-and-quality (push) Failing after 10s
This commit is contained in:
@@ -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)
|
||||
@@ -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)
|
||||
8
docs/README.md
Normal file
8
docs/README.md
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user