From b9ac4fbb7512f87cf31b9dd03e5610d4cc393602 Mon Sep 17 00:00:00 2001 From: Benjamin Admin Date: Wed, 4 Mar 2026 13:48:06 +0100 Subject: [PATCH] feat: Ausfuehrliche Beschreibungen (descriptionLong) fuer alle 13 Architektur-Services Jeder Service hat nun 2-3 Saetze Langbeschreibung, sichtbar im aufklappbaren Detail-Bereich der Service-Tabelle und im rechten Detail-Panel bei Node-Klick. Co-Authored-By: Claude Opus 4.6 --- .../app/sdk/architecture/architecture-data.ts | 14 ++++++++++++++ admin-compliance/app/sdk/architecture/page.tsx | 6 +++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/admin-compliance/app/sdk/architecture/architecture-data.ts b/admin-compliance/app/sdk/architecture/architecture-data.ts index 048c388..4840cf5 100644 --- a/admin-compliance/app/sdk/architecture/architecture-data.ts +++ b/admin-compliance/app/sdk/architecture/architecture-data.ts @@ -21,6 +21,7 @@ export interface ArchService { url: string | null container: string description: string + descriptionLong: string dbTables: string[] ragCollections: string[] apiEndpoints: string[] @@ -95,6 +96,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: 'https://macmini:3007', container: 'bp-compliance-admin', description: 'Haupt-Dashboard fuer alle 17+ DSGVO/AI-Act Compliance-Module. SDK-Sidebar, CommandBar, ComplianceAdvisor.', + descriptionLong: 'Das Admin Compliance Dashboard ist die zentrale Benutzeroberflaeche fuer alle Compliance-Aktivitaeten. Es beinhaltet ueber 48 SDK-Module — von VVT und DSFA ueber Loeschfristen bis hin zu Schulungen und Audit-Reports. Saemtliche Backend-Aufrufe laufen ueber Next.js API-Routes als Reverse Proxy, sodass keine direkten Backend-URLs im Browser exponiert werden.', dbTables: [], ragCollections: [], apiEndpoints: [ @@ -115,6 +117,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: 'https://macmini:3006', container: 'bp-compliance-developer-portal', description: 'API-Dokumentation und SDK-Referenz fuer Kunden-Integration.', + descriptionLong: 'Das Developer Portal richtet sich an externe Entwickler, die das Compliance SDK in ihre eigenen Anwendungen integrieren moechten. Es dokumentiert alle REST-Endpunkte mit Request/Response-Beispielen, Authentifizierungs-Flows und SDK-Initialisierung. Das Portal laeuft als eigenstaendige Next.js-Instanz ohne Backend-Abhaengigkeiten.', dbTables: [], ragCollections: [], apiEndpoints: [], @@ -130,6 +133,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: 'https://macmini:8011', container: 'bp-compliance-docs', description: 'MkDocs-basierte technische Dokumentation. Statische Site via Nginx.', + descriptionLong: 'Die SDK-Dokumentation wird aus Markdown-Quelldateien (docs-src/) mit MkDocs generiert und als statische HTML-Site ueber Nginx ausgeliefert. Sie enthaelt Architektur-Beschreibungen, API-Referenzen, Deployment-Anleitungen und Compliance-Leitfaeden. Updates werden durch einen Docker-Rebuild automatisch veroeffentlicht.', dbTables: [], ragCollections: [], apiEndpoints: [], @@ -147,6 +151,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: 'https://macmini:8002', container: 'bp-compliance-backend', description: 'Zentrale Compliance-API: DSGVO, DSR, GDPR, VVT, Loeschfristen, Obligations, Legal Documents, Consent.', + descriptionLong: 'Das Backend Compliance ist das Herzsttueck der Datenverarbeitung. Es verwaltet 16+ DB-Tabellen fuer Risiken, Kontrollen, Nachweise, VVT-Eintraege, Loeschfristen, rechtliche Dokumente und Einwilligungen. Alle CRUD-Operationen laufen ueber SQLAlchemy mit Pydantic-Validierung. Sessions und Caching werden ueber Valkey (Redis-kompatibel) abgewickelt, um schnelle Antwortzeiten zu gewaehrleisten.', dbTables: [ 'compliance_risks', 'compliance_controls', 'compliance_requirements', 'compliance_evidence', 'compliance_vvt', 'compliance_loeschfristen', @@ -183,6 +188,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: 'https://macmini:8093', container: 'bp-compliance-ai-sdk', description: 'KI-konforme Compliance-Analyse: UCCA, Training, RAG-Suche, IACE, Portfolio, Roadmap, Workshop.', + descriptionLong: 'Der AI Compliance SDK Service ist in Go geschrieben und bietet KI-gestuetzte Compliance-Analysen. Er fuehrt UCCA-Bewertungen (Use Case Compliance Assessments) durch, verwaltet Schulungsmodule mit Fortschrittstracking und durchsucht Rechtstexte per RAG (Retrieval Augmented Generation) ueber Qdrant. Als LLM wird primaer Ollama (qwen3:30b-a3b) lokal genutzt, mit Fallback auf Claude Sonnet ueber die Anthropic API.', dbTables: [ 'ai_assessments', 'ai_training_modules', 'ai_training_progress', ], @@ -210,6 +216,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: 'https://macmini:8098', container: 'bp-compliance-document-crawler', description: 'Dokument-Analyse (PDF, DOCX, XLSX, PPTX), Gap-Analyse, IPFS-Archivierung.', + descriptionLong: 'Der Document Crawler nimmt hochgeladene Dokumente (PDF, DOCX, XLSX, PPTX) entgegen, extrahiert deren Inhalt und fuehrt eine Gap-Analyse gegen bestehende Compliance-Anforderungen durch. Dafuer leitet er die Textinhalte an den AI Compliance SDK weiter, der die semantische Analyse uebernimmt. Abgeschlossene Dokumente koennen ueber den DSMS-Service dezentral auf IPFS archiviert werden.', dbTables: [], ragCollections: [], apiEndpoints: [ @@ -229,6 +236,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: null, container: 'bp-compliance-tts', description: 'Text-to-Speech fuer Schulungsvideos. Piper TTS (de_DE-thorsten-high), Video-Generierung, MinIO-Storage.', + descriptionLong: 'Der TTS-Service wandelt Schulungstexte in natuerlich klingende Sprache um und generiert daraus komplette Schulungsvideos. Er nutzt das deutsche Piper-TTS-Modell (thorsten-high) fuer die Sprachsynthese und FFmpeg fuer die Video-Komposition. Die fertigen Audio- und Videodateien werden in MinIO (S3-kompatibel) gespeichert und koennen ueber das Training-Modul abgerufen werden.', dbTables: [], ragCollections: [], apiEndpoints: [ @@ -249,6 +257,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: null, container: 'bp-core-postgres', description: 'Zentrale Datenbank. Schemas: compliance, core, public. Shared mit breakpilot-core.', + descriptionLong: 'PostgreSQL ist die gemeinsame Datenbank fuer das gesamte BreakPilot-Oekosystem. Das compliance-Schema enthaelt alle Compliance-spezifischen Tabellen, waehrend core und public von breakpilot-core bereitgestellt werden. Der search_path ist auf compliance,core,public konfiguriert, sodass Services transparent auf Schema-uebergreifende Daten zugreifen koennen.', dbTables: [], ragCollections: [], apiEndpoints: [], @@ -264,6 +273,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: null, container: 'bp-core-valkey', description: 'Session-Cache und Pub/Sub. Redis-kompatibel, von breakpilot-core bereitgestellt.', + descriptionLong: 'Valkey ist ein Redis-kompatibler In-Memory-Store, der von breakpilot-core bereitgestellt wird. Er speichert Session-Daten, kurzlebige Caches und dient als Pub/Sub-Broker fuer Event-basierte Kommunikation zwischen Services. Durch die Redis-Kompatibilitaet koennen bestehende Redis-Clients und -Bibliotheken ohne Aenderungen verwendet werden.', dbTables: [], ragCollections: [], apiEndpoints: [], @@ -279,6 +289,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: null, container: 'bp-core-qdrant', description: 'Vektor-Datenbank fuer RAG-Compliance-Suche. Collections: DSGVO, AI Act, BDSG, TTDSG.', + descriptionLong: 'Qdrant speichert Vektorembeddings von Rechtstexten und Compliance-Dokumenten in thematischen Collections (DSGVO, AI Act, BDSG, TTDSG, Templates). Der AI Compliance SDK nutzt diese fuer semantische Suchen — Nutzer koennen so in natuerlicher Sprache nach relevanten Gesetzespassagen und Compliance-Anforderungen suchen, ohne exakte Suchbegriffe kennen zu muessen.', dbTables: [], ragCollections: [ 'bp_dsgvo', 'bp_ai_act', 'bp_bdsg', 'bp_ttdsg', @@ -297,6 +308,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: null, container: 'bp-core-minio', description: 'Object Storage fuer TTS-Audio, generierte Videos und Dokument-Uploads.', + descriptionLong: 'MinIO stellt S3-kompatiblen Object Storage bereit und wird von breakpilot-core verwaltet. Der Compliance-Stack nutzt es primaer fuer generierte Schulungsvideos und Audio-Dateien aus dem TTS-Service. Durch die S3-API-Kompatibilitaet koennen Standard-AWS-SDKs fuer den Zugriff verwendet werden.', dbTables: [], ragCollections: [], apiEndpoints: [], @@ -312,6 +324,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: null, container: 'bp-core-ollama', description: 'Lokaler LLM-Server. Modell: qwen3:30b-a3b. Fallback: Claude Sonnet via Anthropic API.', + descriptionLong: 'Ollama hostet ein lokales Large Language Model (qwen3:30b-a3b) fuer Compliance-Analysen, Textgenerierung und UCCA-Bewertungen. Durch die lokale Ausfuehrung bleiben alle Daten im eigenen Netzwerk — ein zentraler Vorteil fuer DSGVO-Konformitaet. Ist das lokale Modell nicht verfuegbar oder die Aufgabe zu komplex, wird automatisch auf Claude Sonnet ueber die Anthropic API zurueckgegriffen.', dbTables: [], ragCollections: [], apiEndpoints: [], @@ -329,6 +342,7 @@ export const ARCH_SERVICES: ArchService[] = [ url: null, container: 'bp-compliance-dsms-node / dsms-gateway', description: 'Data Sovereignty Management System. IPFS-Node (Kubo) + Gateway fuer dezentrale Dokument-Archivierung.', + descriptionLong: 'Das DSMS (Data Sovereignty Management System) besteht aus einem IPFS-Node (Kubo) und einem Node.js-Gateway. Es ermoeglicht die dezentrale, manipulationssichere Archivierung von Compliance-Dokumenten ueber das InterPlanetary File System. Jedes archivierte Dokument erhaelt einen Content Identifier (CID), der als kryptografischer Nachweis der Dokumentenintegritaet dient.', dbTables: [], ragCollections: [], apiEndpoints: [ diff --git a/admin-compliance/app/sdk/architecture/page.tsx b/admin-compliance/app/sdk/architecture/page.tsx index c546528..290f075 100644 --- a/admin-compliance/app/sdk/architecture/page.tsx +++ b/admin-compliance/app/sdk/architecture/page.tsx @@ -101,6 +101,7 @@ function DetailPanel({
{/* Beschreibung */}

{service.description}

+

{service.descriptionLong}

{/* Tech + Port + Container */}
@@ -800,9 +801,12 @@ export default function ArchitecturePage() { {isExpanded && (
{/* Beschreibung */} -

+

{service.description}

+

+ {service.descriptionLong} +

{/* Info Grid */}