ADR-0022: Dokumentation und RAG-Stack¶
Status: Akzeptiert Letztes Update: 2026-03-12
Entscheidungszusammenfassung¶
Jorvis verwendet einen Dokumentations-Stack, der aufgebaut ist um:
- MkDocs für die Anzeige (Rendering) der Dokumentation
- Open WebUI + pgvector für RAG und Informationsabfragen im Chat
- ProcessorFactory-Pipeline zum Importieren von Unternehmensdokumenten in den RAG-Index
Unterstützte Import-Quellen¶
- Cloud-Konnektoren: Google Docs (Nur-Lesen), Google Drive (Nur-Lesen), Google Sheets (Nur-Lesen)
- Office-Dokumente: PDF, DOCX, XLSX, PPTX
- Strukturierte/Web-Formate: JSON, HTML, CSV, reiner Text, Markdown
- Embedding: Dokumente werden in Fragmente (Chunks) zerlegt, über ein Gemini-Embedding-Modell in Embeddings umgewandelt und in pgvector für die semantische Suche gespeichert.
Warum dies gewählt wurde¶
- Es passt perfekt zum bestehenden Self-Hosted-Stack.
- Es hält den Ressourcenverbrauch zur Laufzeit (Runtime Overhead) gering.
- Es unterstützt Mermaid-Diagramme und statische Veröffentlichungen.
- Es vermeidet das Hinzufügen einer zweiten schweren Dokumentationsumgebung, da der aktuelle Stack bereits die Informationsabfrage (Retrieval) unterstützt.
- Das ProcessorFactory-Muster lässt sich ohne architektonische Änderungen problemlos für neue Dokumentformate erweitern.
Ergebnis für die öffentliche Referenz¶
Die öffentlichen Visualisierungen verlinken nun auf einen speziellen mkdocs-public.yml Build unter /reference-de/, sodass Browser-Benutzer auf gerenderte HTML-Seiten anstelle von rohen Markdown-Dateien oder internen Governance-Routen landen.