Skip to content

ADR-0022: Dokumentace a RAG Stack

Stav: Přijato Poslední aktualizace: 2026-03-12

Shrnutí Rozhodnutí

Jorvis využívá dokumentační stack (sestavu nástrojů) postavený na:

  • MkDocs pro vykreslování (rendering) dokumentace
  • Open WebUI + pgvector pro procesy RAG a získávání dat v chatu
  • Pipeline ProcessorFactory pro import podnikových dokumentů do RAG indexu

Podporované Zdroje pro Import

  • Cloudové konektory: Google Docs (pouze pro čtení), Google Drive (pouze pro čtení), Google Sheets (pouze pro čtení)
  • Kancelářské dokumenty: PDF, DOCX, XLSX, PPTX
  • Strukturované/webové formáty: JSON, HTML, CSV, prostý text, Markdown
  • Embedding: dokumenty jsou rozděleny na fragmenty (chunks), převedeny na embeddingy pomocí modelu Gemini a uloženy v pgvector pro sémantické vyhledávání.

Proč To Bylo Vybráno

  • Hodí se to do stávajícího self-hosted stacku.
  • Udržuje nízkou režii běhového prostředí (runtime overhead).
  • Podporuje diagramy Mermaid a statické publikování.
  • Vyhýbá se přidání druhého těžkého dokumentačního prostředí, protože současný stack již podporuje vyhledávání informací (retrieval).
  • Vzor ProcessorFactory se dá snadno rozšířit o nové formáty dokumentů bez architektonických změn.

Výsledek pro Veřejné Reference

Veřejné vizualizace nyní odkazují na vyhrazený build mkdocs-public.yml pod složkou /reference-cs/, takže uživatelé v prohlížeči přistanou na vyrenderovaných HTML stránkách namísto surového Markdownu nebo interních tras pro správu.

Související Veřejné Reference