Benjamin_Boenisch/breakpilot-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update MkDocs for 3-project architecture (core/lehrer/compliance)

Browse Source 
- Rewrite system-architecture.md with new 3-project diagram
- Update index.md with Core services table and nginx routing
- Replace service docs that moved to lehrer/compliance with redirects
  (klausur-service, voice-service, agent-core, ki-daten-pipeline -> lehrer)
  (ai-compliance-sdk -> compliance)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Benjamin Boenisch
2026-02-14 19:51:09 +01:00
parent f2a24d7341
commit fdfe38b61a
7 changed files with 260 additions and 1414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

167
docs-src/index.md
View File

@@ -1,124 +1,71 @@
# Breakpilot Dokumentation
# BreakPilot Core - Dokumentation
Willkommen zur zentralen Dokumentation des Breakpilot-Projekts.
Zentrale Infrastruktur-Dokumentation fuer das BreakPilot-Oekosystem.
## Was ist Breakpilot?
## Drei-Projekt-Architektur
Breakpilot ist eine DSGVO-konforme Bildungsplattform fuer Lehrkraefte mit folgenden Kernfunktionen:
BreakPilot besteht aus drei unabhaengigen Projekten:
- **Consent-Management** - Datenschutzkonforme Einwilligungsverwaltung
- **KI-gestuetzte Klausurkorrektur** - Automatische Bewertungsvorschlaege fuer Abiturklausuren
- **Zeugnisgenerierung** - Workflow-basierte Zeugniserstellung mit Rollenkonzept
- **Lernmaterial-Generator** - MC-Tests, Lueckentexte, Mindmaps, Quiz
- **Elternbriefe** - GFK-basierte Kommunikation mit PDF-Export
| Projekt | Beschreibung | Container-Prefix | Farbe |
|---------|-------------|-------------------|-------|
| **breakpilot-core** (dieses Projekt) | Shared Infrastructure | `bp-core-*` | Teal |
| **breakpilot-lehrer** | Bildungs-Stack (Team A) | `bp-lehrer-*` | Blau |
| **breakpilot-compliance** | DSGVO/Compliance-Stack (Team B) | `bp-compliance-*` | Lila |
## Schnellstart
## Core Services
<div class="grid cards" markdown>
| Service | Container | Port | Beschreibung |
|---------|-----------|------|--------------|
| Nginx | bp-core-nginx | 80/443 | Reverse Proxy + TLS fuer alle drei Projekte |
| PostgreSQL | bp-core-postgres | 5432 | Zentrale Datenbank (PostGIS 16) |
| Valkey | bp-core-valkey | 6379 | Session Cache (Redis-Fork) |
| Vault | bp-core-vault | 8200 | Secrets Management |
| Qdrant | bp-core-qdrant | 6333 | Vector DB fuer RAG |
| MinIO | bp-core-minio | 9000 | S3-kompatibler Object Storage |
| Embedding Service | bp-core-embedding-service | 8087 | Text-Embeddings |
| RAG Service | bp-core-rag-service | 8097 | Retrieval Augmented Generation |
| Consent Service | bp-core-consent-service | 8081 | DSGVO Consent (Go) |
| Billing Service | bp-core-billing-service | 8083 | Abrechnung (Go) |
| Backend Core | bp-core-backend | 8000 | Shared API (Python) |
| Admin Core | bp-core-admin | 3008 | Admin-Dashboard (Next.js) |
| Health Aggregator | bp-core-health | 8099 | Service-Health Monitoring |
| Night Scheduler | bp-core-night-scheduler | 8096 | Nachtabschaltung |
| Pitch Deck | bp-core-pitch-deck | 3012 | Investor-Praesentation |
| Mailpit | bp-core-mailpit | 8025 | E-Mail (Entwicklung) |
| Gitea | bp-core-gitea | 3003 | Git-Server |
| Woodpecker | bp-core-woodpecker-server | 8090 | CI/CD |
| Jitsi (5 Container) | bp-core-jitsi-* | 8443 | Videokonferenzen |
- :material-rocket-launch:{ .lg .middle } **Erste Schritte**
## Nginx Routing-Tabelle
---
Entwicklungsumgebung einrichten und das Projekt starten.
[:octicons-arrow-right-24: Umgebung einrichten](getting-started/environment-setup.md)
- :material-server:{ .lg .middle } **Mac Mini Setup**
---
Headless Server-Konfiguration fuer den Entwicklungsserver.
[:octicons-arrow-right-24: Mac Mini Setup](getting-started/mac-mini-setup.md)
</div>
| Port | Upstream | Projekt |
|------|----------|---------|
| 443 | bp-lehrer-studio-v2:3001 | Lehrer |
| 3000 | bp-lehrer-website:3000 | Lehrer |
| 3002 | bp-lehrer-admin:3000 | Lehrer |
| 3006 | bp-compliance-developer-portal:3000 | Compliance |
| 3007 | bp-compliance-admin:3000 | Compliance |
| 3008 | bp-core-admin:3000 | Core |
| 8000 | bp-core-backend:8000 | Core |
| 8001 | bp-lehrer-backend:8001 | Lehrer |
| 8002 | bp-compliance-backend:8002 | Compliance |
| 8086 | bp-lehrer-klausur-service:8086 | Lehrer |
| 8087 | bp-core-embedding-service:8087 | Core |
| 8091 | bp-lehrer-voice-service:8091 | Lehrer |
| 8093 | bp-compliance-ai-sdk:8090 | Compliance |
| 8097 | bp-core-rag-service:8097 | Core |
| 8443 | bp-core-jitsi-web:80 | Core |
## Architektur
<div class="grid cards" markdown>
- :material-sitemap:{ .lg .middle } **System-Architektur**
---
Ueberblick ueber alle Komponenten und deren Zusammenspiel.
[:octicons-arrow-right-24: Architektur](architecture/system-architecture.md)
- :material-shield-lock:{ .lg .middle } **Auth-System**
---
Hybrid-Authentifizierung mit Keycloak und lokalem JWT.
[:octicons-arrow-right-24: Auth-System](architecture/auth-system.md)
- :material-robot:{ .lg .middle } **Multi-Agent System**
---
Verteilte Agent-Architektur fuer KI-Funktionen.
[:octicons-arrow-right-24: Multi-Agent](architecture/multi-agent.md)
- :material-key-chain:{ .lg .middle } **Secrets Management**
---
HashiCorp Vault Integration fuer sichere Credentials.
[:octicons-arrow-right-24: Secrets](architecture/secrets-management.md)
</div>
## Services
| Service | Port | Beschreibung |
|---------|------|--------------|
| [Backend (Python)](api/backend-api.md) | 8000 | FastAPI Backend mit Panel UI |
| [Consent Service (Go)](architecture/auth-system.md) | 8081 | DSGVO-konforme Einwilligungsverwaltung |
| [Klausur Service](services/klausur-service/index.md) | 8086 | KI-gestuetzte Klausurkorrektur |
| [Agent Core](services/agent-core/index.md) | - | Multi-Agent Infrastructure |
| PostgreSQL | 5432 | Relationale Datenbank |
| Qdrant | 6333 | Vektor-Datenbank fuer RAG |
| MinIO | 9000 | Object Storage |
| Vault | 8200 | Secrets Management |
- [System-Architektur](architecture/system-architecture.md)
- [Auth-System](architecture/auth-system.md)
- [Secrets Management](architecture/secrets-management.md)
- [DevSecOps](architecture/devsecops.md)
- [Multi-Agent System](architecture/multi-agent.md)
## Entwicklung
- [Testing](development/testing.md) - Test-Standards und Ausfuehrung
- [Dokumentation](development/documentation.md) - Dokumentations-Richtlinien
- [DevSecOps](architecture/devsecops.md) - Security Pipeline
- [Umgebungen](architecture/environments.md) - Dev/Staging/Prod
## Weitere Ressourcen
- **GitHub Repository**: Internes GitLab
- **Issue Tracker**: GitLab Issues
- **API Playground**: [http://macmini:8000/docs](http://macmini:8000/docs)
---
## Projektstruktur
```
breakpilot-pwa/
├── backend/ # Python FastAPI Backend
├── consent-service/ # Go Consent Service
├── klausur-service/ # Klausur-Korrektur Service
├── agent-core/ # Multi-Agent Infrastructure
├── voice-service/ # Voice/Audio Processing
├── website/ # Next.js Frontend
├── studio-v2/ # Admin Dashboard (Next.js)
├── docs-src/ # Diese Dokumentation
└── docker-compose.yml # Container-Orchestrierung
```
## Support
Bei Fragen oder Problemen:
1. Pruefen Sie zuerst die relevante Dokumentation
2. Suchen Sie im Issue Tracker nach aehnlichen Problemen
3. Erstellen Sie ein neues Issue mit detaillierter Beschreibung
- [Testing](development/testing.md)
- [Dokumentation](development/documentation.md)
- [CI/CD Pipeline](development/ci-cd-pipeline.md)