Gleam.br Wiki

ADR-0022: Relatório de Auditoria e Consistência da Documentação Multidomínio | Wiki

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

ADR-0022: Relatório de Auditoria e Consistência da Documentação Multidomínio

Este documento especifica a decisão de arquitetura para a auditoria rigorosa de documentação do monorepo gleam-lang-br e do gerador estático gbr_ssg, alinhando os arquivos .djot da árvore de conteúdo por domínios (fvideen.com.br, gleam-lang.com.br, gleam.dev.br), /blog/ e /wiki/ com as especificações reais de engenharia de ./apps/, ./packages/ e com os templates HTML oficiais.

1. Contexto e Motivação

A recente reestruturação da árvore de conteúdo do gbr_ssg (/content/) segregou as landing pages por domínio (fvideen.com.br, gleam-lang.com.br, gleam.dev.br), centralizou o /blog/, a /wiki/ (substituindo o antigo /blueprint/ solto e /docs/) e o /content/index.djot como Hub Central de Atalhos.

No entanto, a auditoria da documentação identificou desalinhamentos significativos: 1. **Catalogação Incompleta no apps/README.md**: O README.md de aplicações omite o motor gbr_ssg. 2. **Catalogação Incompleta no packages/README.md**: O README.md de pacotes lista apenas 5 das 24 bibliotecas reais existentes em ./packages/ (omitindo gbr_ssg_core, gbr_mcp, gbr_mnesia, gbr_graph, gbr_p2p_gossipsub, gbr_json, gbr_llm, gbr_vector, gbr_tokenizer, gbr_inets, gbr_httpc, gbr_bpm, gbr_ai_sdk, etc.). 3. **Páginas de Domínio Faltantes no .djot**: O zip de referência fvideen.com.br-main.zip possui 4 páginas (index.html, membros.html, perfil-paulo.html, perfil-rodrigo.html), enquanto content/fvideen.com.br/ possui apenas index.djot. 4. **Páginas da Comunidade (gleam.dev.br)**: O zip de referência gleam.dev.br-main.zip possui páginas dedicadas como etica.html e valores.html que foram agrupadas ou renomeadas no .djot. 5. *Redirecionamento de Links do Blueprint*: Os links internos que apontavam para /blueprint/ precisam ser migrados para a nova estrutura sob /wiki/blueprint/ sem quebrar referências existentes.


2. Decisão Arquitetural

  1. *Matriz de Intervenção de Documentação (Criar, Alterar, Excluir):* - *🔴 EXCLUIR*: - content/site_test.djot (arquivo temporário de teste de compilação da raiz de content). - Páginas duplicadas ou legadas fora do padrão por domínios. - *🟡 ALTERAR*: - README.md (raiz do monorepo): Atualizar referências de arquitetura e atalhos para os 3 domínios da holding. - apps/README.md: Adicionar o gbr_ssg ao catálogo de aplicações com sua respectiva descrição e arquitetura. - packages/README.md: Expandir o catálogo para incluir as 24 bibliotecas ativas com links para seus respectivos READMEs. - content/index.djot: Refinar como Hub de Atalhos conectando FVideen, Gleam Lang BR, Gleam Dev BR, Blog e Wiki. - Redirecionar referências de /blueprint/ em todos os .djot para a rota canonical /wiki/blueprint/. - *🟢 CRIAR*: - content/fvideen.com.br/membros.djot: Página "Nossa Elite Técnica" (convertida de membros.html). - content/fvideen.com.br/perfil-paulo.djot: Perfil individual de Paulo Ricardo Sales (convertida de perfil-paulo.html). - content/fvideen.com.br/perfil-rodrigo.djot: Perfil individual de Rodrigo Tenedini Castela (convertida de perfil-rodrigo.html). - content/gleam.dev.br/etica.djot: Página "Licença Ética" desmembrada/alinhada ao template etica.html. - content/gleam.dev.br/valores.djot: Página "Nossos Valores" alinhada ao template valores.html. - content/wiki/index.djot: Portal de entrada da Wiki com navegação estruturada por ADRs, Blueprint, Engenharia e Docs.

  2. **Estratégia de Preservação de Links Internos do Startup Blueprint (/blueprint/ $\rightarrow$ /wiki/):** - Toda referência textual a /blueprint/ nos arquivos .djot e documentações será atualizada cirurgicamente para /wiki/blueprint/. - No motor SSG / Edge, será mantido um alias/redirecionamento de compatibilidade de /blueprint/* para /wiki/blueprint/*.


3. Requisitos EARS

*Requisitos Ubíquos (Ubiquitous Requirements)* - *UBQ-01 (Sincronismo de Catálogo de Engenharia):* Os catálogos apps/README.md e packages/README.md DEVEM conter 100% dos pacotes e aplicações reais da árvore de código do monorepo. - *UBQ-02 (Espelhamento de Domínios em Djot):* Cada subdiretório de domínio (content/fvideen.com.br/, content/gleam-lang.com.br/, content/gleam.dev.br/) DEVE espelhar rigorosamente todas as páginas presentes nos pacotes ZIP de referência (docs/00-ADR-EARS/gbr_ssg/*.zip). - *UBQ-03 (Hub Central de Atalhos):* A página content/index.djot DEVE funcionar como um Hub de Atalhos limpo, direcionando para os 3 domínios corporativos, o Blog e a Wiki.

*Requisitos de Resposta a Eventos (Event-Driven Requirements)* - *EVT-01 (Redirecionamento de Links do Blueprint):* QUANDO o usuário acessar rotas sob /blueprint/*, O sistema DEVE resolver a requisição para o portal /wiki/blueprint/*.