Contributing¶
Repo organization¶
This is the central hub for the Praesenz kiosk platform. It contains documentation, architecture decisions, roadmaps, studies, pricing, and the central task tracker.
Heavy code and assets live in dedicated repos:
| Repo | Content | Owner |
|---|---|---|
| praesenz/engineering-avatar | UE5 MetaHuman, Pixel Streaming, Audio2Face | Content Engineering |
| praesenz/engineering-frontend | WebRTC player, signalling, conversation UI | Frontend |
| praesenz/engineering-ai | Orchestrator, STT, LLM, TTS, RAG | Backend |
| praesenz/engineering-infra | Helm, Fleet, podman-compose, EIB, GPU passthrough | Platform / Infra |
Workflow¶
- Product decisions go in
product/ - Architecture decisions go in
architecture/decisions/as ADRs (numbered) - Stack B design lives in
architecture/stack-b/(migrated from stack-b-design repo) - Status updates go in
STATUS.md(single source of truth)
Naming conventions¶
- ADRs:
NNN-short-title.md(e.g.001-two-stacks.md) - Roadmaps: descriptive name in
roadmaps/ - Studies: descriptive name in
studies/
Language¶
All documentation in English. Code comments in English.
Backups before destructive operations¶
Before renaming repos, migrating content across repos, or archiving repos:
- Clone the affected repo(s) locally
- Push the snapshot to lab-home/backups in a dated folder
- Document the operation in the backups README
Backup repo: http://gitea.cledorze.lan/lab-home/backups
This is mandatory for any operation that changes repo names, moves files between repos, or archives repos. The backup is append-only — never delete old snapshots.