ADR-0022: Документація та RAG стек¶
Статус: Прийнято Останнє оновлення: 2026-03-12
Короткий зміст рішення¶
Jorvis використовує стек документації, побудований навколо:
- MkDocs для рендерингу документації
- Open WebUI + pgvector для RAG та пошуку в чаті
- Пайплайн ProcessorFactory для завантаження корпоративних документів у RAG індекс
Підтримувані джерела імпорту¶
- Хмарні конектори: Google Docs (лише для читання), Google Drive (лише для читання), Google Sheets (лише для читання)
- Офісні документи: PDF, DOCX, XLSX, PPTX
- Структуровані/веб формати: JSON, HTML, CSV, звичайний текст, Markdown
- Ембединги: документи розбиваються на фрагменти, перетворюються в ембединги через Gemini embedding model і зберігаються у pgvector для семантичного пошуку
Чому це було обрано¶
- Це підходить для існуючого self-hosted стеку.
- Це зберігає низьке навантаження в середовищі виконання.
- Підтримує діаграми Mermaid та статичну публікацію.
- Це дозволяє уникнути додавання другого важкого середовища для документації, коли поточний стек вже підтримує пошук інформації.
- Патерн ProcessorFactory легко розширюється для нових форматів документів без архітектурних змін.
Результат для публічної документації¶
Публічні візуалізації тепер посилаються на окрему збірку mkdocs-public.yml за шляхом /reference/, щоб користувачі в браузері потрапляли на відрендерені HTML сторінки, а не на сирий Markdown або внутрішні маршрути управління.