Começar
Aparência

Vale na hora e fica lembrada neste navegador.

Decisões

ADR-0004 — Site da arquitetura

Contexto

A documentação precisa ser lida por pessoas que não abrem o repositório, inclusive sem rede, e com a cara da Hibex. Renderizar Markdown no navegador depende de bibliotecas de fora e não funciona offline.

Decisão

  1. Um site estático, gerado dos Markdown por site/gerar.mjs (com marked em versão fixa), em site/dist/: HTML pronto, que funciona sem rede.
  2. Usa o design system da Hibex (cópia em vendor/hibex/, família cobalt), com o verificador sem erro antes de toda entrega.
  3. Os rabiscos entram inline nas páginas e seguem a Aparência escolhida (Sistema, Claro, Escuro).
  4. O site é aberto e indexado, como o do design system, em architecture.enterprise.hibex.net.
  5. Publicação por imagem Docker (nginx-unprivileged, não-root) e Kamal, com segredos só por referência; quem publica é o mantenedor.

Alternativas consideradas

AlternativaPor que não
Ler os Markdown no GitHubPor que não: sem a identidade da Hibex; rabiscos sem o tema escolhido
Gerador de sites pronto (MkDocs, Docusaurus)Por que não: traz o próprio visual, que concorre com o design system
Renderizar Markdown no navegadorPor que não: depende de rede e de bibliotecas de fora

Consequências

  • Mudou um documento ou um rabisco: regere o site.
  • O que falta no design system para o site vira pedido (docs/design-system/pedidos.md).