Gleam.br Wiki

ADR-0023: Espelhamento de READMEs de Aplicações e Pacotes para a Wiki Estática | Wiki

Documentação de engenharia e especificações técnicas da Gleam-BR.

ADR-0023: Espelhamento de READMEs de Aplicações e Pacotes para a Wiki Estática

Este documento especifica a decisão de arquitetura para a conversão e espelhamento sistemático dos arquivos README.md de engenharia do monorepo (/apps/*/README.md e /packages/*/README.md) em páginas de documentação estática no formato .djot dentro do portal da Wiki (/content/wiki/apps/ e /content/wiki/packages/).

1. Contexto e Motivação

Atualmente, os arquivos README.md localizados em cada diretório de aplicação (./apps/*) e biblioteca (./packages/*) servem como documentação técnica primária para desenvolvedores ao inspecionarem o código-fonte no repositório.

Entretanto, para os usuários, arquitetos e membros da comunidade que navegam através dos portais públicos/privados gerados pelo gbr_ssg, essa documentação técnica permanecia isolada do gerador estático.

Para resolver essa fragmentação e fornecer uma base de conhecimento viva e navegável via web, converteremos e espelharemos esses READMEs para o formato .djot, categorizando-os em rotas estruturadas na Wiki (/wiki/apps/ e /wiki/packages/).


2. Decisão Arquitetural

  1. *Topologia de Diretórios da Wiki para Catálogos de Engenharia:* - **/content/wiki/apps/**: Páginas .djot geradas a partir dos README.md de cada subprojeto em ./apps/ (ex: gbr_ai_gleam.djot, gbr_ai_harness.djot, gbr_mcp_bpm.djot, gbr_mcp_semantic.djot, gbr_mcp_gleam.djot, gbr_mcp_lsp_gleam.djot, gbr_ssg.djot). - **/content/wiki/packages/**: Páginas .djot geradas a partir dos README.md de cada pacote em ./packages/ (ex: gbr_os.djot, gbr_ets.djot, gbr_ssg_core.djot, gbr_p2p.djot, gbr_mcp.djot, gbr_mnesia.djot, etc.).

  2. *Formatação Frontmatter TOML Standardizada:* Todas as páginas geradas receberão o frontmatter estipulado para a Wiki: toml +++ title = "[Nome do Pacote/App] | Documentação de Engenharia" description = "Especificação técnica e manual de uso do componente." category = "Engenharia" layout = "wiki" +++

  3. *Estratégia de Sincronia Futura (Questionário Crítico):* Para evitar drift e dessincronização entre os README.md do repositório e os arquivos .djot da Wiki, um comando CLI ou task Gleam em gbr_ssg poderá automatizar a varredura e conversão no pipeline de CI/CD.


3. Requisitos EARS

*Requisitos Ubíquos (Ubiquitous Requirements)* - *UBQ-01 (Mapeamento Total de Catálogos):* O motor de build da Wiki DEVE compilar e expor páginas .djot equivalentes para 100% dos arquivos README.md contidos nos diretórios ./apps/ e ./packages/. - *UBQ-02 (Integridade de Roteamento):* Todas as páginas de documentação de pacotes e aplicações DEVEM ser acessíveis através de URIs canônicas sob /wiki/apps/<app>.html e /wiki/packages/<package>.html.

*Requisitos de Resposta a Eventos (Event-Driven Requirements)* - *EVT-01 (Navegação Centralizada):* QUANDO a página wiki/index.html for renderizada, O portal DEVE exibir a árvore completa de navegabilidade categorizada por Aplicações e Bibliotecas.