Skip to content

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 и сохраняются в pgvector для семантического поиска

Почему это было выбрано

  • Это подходит для существующего self-hosted стека.
  • Это сохраняет низкую нагрузку в среде выполнения.
  • Поддерживает диаграммы Mermaid и статическую публикацию.
  • Это позволяет избежать добавления второй тяжелой среды для документации, когда текущий стек уже поддерживает поиск информации.
  • Паттерн ProcessorFactory легко расширяется для новых форматов документов без архитектурных изменений.

Результат для публичной документации

Публичные визуализации теперь ссылаются на отдельную сборку mkdocs-public.yml по пути /reference/, чтобы пользователи в браузере попадали на отрендеренные HTML-страницы, а не на сырой Markdown или внутренние маршруты управления.

Связанные публичные справочники