ADR-0014: Estrutura da Base de Conhecimento e Topologia de Documentação | Wiki
ADR-0014: Estrutura da Base de Conhecimento e Topologia de Documentação
Este documento especifica a decisão de design sobre a organização da Base de Conhecimento interna (Startup Blueprint) e da Documentação Técnica do Monorepo no gerador estático gbr_ssg.
1. Contexto e Motivação
Além das landing pages institucionais do layout "Site", o ecossistema Gleam-BR necessita de uma Base de Conhecimento estruturada em formato Wiki para documentar a visão estratégica de negócios, arquitetura de startup, especificações de protocolos (P2P/CRDT) e guias técnicos do monorepo. Essa base será dividida entre áreas públicas e privadas protegidas via Cloudflare Zero Trust.
2. Decisão Arquitetural
-
*Topologia de Diretórios da Base de Conhecimento:* - **
/content/blueprint/(Área Privada de Negócios & Arquitetura):** Contém a visão geral da startup, planejamento estratégico, OKRs, arquitetura de sistemas e especificações de protocolos distribuídos (P2P/CRDT). - **/content/docs/(Área Técnica do Monorepo):** Contém guias de contribuição, padrões de código, documentação de pacotes internos (gbr_ssg_core,gbr_mcp,gbr_ui) e manuais do gerador estático. -
*Padronização de Layout e Navegação por Sidebar:* Todos os documentos nestas categorias utilizarão obrigatoriamente
layout = "wiki"no Frontmatter TOML. A ordenação da barra lateral (Sidebar) será controlada explicitamente pelo campoorder: Int(menor valor primeiro).
3. Requisitos EARS
*Requisitos Ubíquos (Ubiquitous Requirements)*
- *UBQ-01 (Padronização do Layout Wiki):* Todos os documentos criados em /content/blueprint/ e /content/docs/ DEVEM definir a propriedade layout = "wiki" e fornecer campos válidos de category e order no Frontmatter TOML.
- *UBQ-02 (Integração na Árvore de Navegação):* O motor de compilação gbr_ssg_core DEVE incluir automaticamente os novos documentos na árvore de navegação global (SiteIndex), agrupando-os por categoria e ordenando-os na Sidebar do layout_wiki.