ADR-0022: Documentação e Pilha RAG¶
Status: Aceito Última atualização: 2026-03-12
Resumo da Decisão¶
O Jorvis utiliza uma pilha de documentação baseada em:
- MkDocs para renderização da documentação
- Open WebUI + pgvector para processos RAG e recuperação de chat
- Pipeline ProcessorFactory para ingestão de documentos corporativos no índice RAG
Fontes de Ingestão Suportadas¶
- Conectores na Nuvem: Google Docs (somente leitura), Google Drive (somente leitura), Google Sheets (somente leitura)
- Documentos de escritório: PDF, DOCX, XLSX, PPTX
- Formatos estruturados/web: JSON, HTML, CSV, texto simples, Markdown
- Embedding: os documentos são divididos em fragmentos (chunks), convertidos em embeddings por meio de um modelo do Gemini e armazenados no pgvector para pesquisa semântica.
Por Que Foi Escolhido¶
- Ele se adapta à pilha auto-hospedada (self-hosted) existente.
- Mantém a sobrecarga no tempo de execução (runtime overhead) baixa.
- Oferece suporte a diagramas Mermaid e publicação estática.
- Evita adicionar um segundo ambiente pesado de documentação, já que a pilha atual suporta recuperação de informações (retrieval).
- O padrão ProcessorFactory é facilmente extensível para novos formatos de documentos sem alterações na arquitetura.
Resultado da Referência Pública¶
As visualizações públicas agora trazem links para uma compilação dedicada do mkdocs-public.yml em /reference-pt/, de forma que os usuários do navegador chegam em páginas HTML renderizadas, em vez de Markdown bruto ou rotas de governança internas.