Skip to content

Governance

šŸ“š Enterprise Documentation Engine

  • Toda alteraĆ§Ć£o estrutural (schema, contratos de API, fluxos crĆ­ticos ou governanƧa) exige atualizaĆ§Ć£o da documentaĆ§Ć£o em /docs.
  • O snapshot de schema Ć© gerado automaticamente por scripts/generate-schema-snapshot.js via leitura da view vw_schema_snapshot.
  • PRs sem atualizaĆ§Ć£o documental obrigatĆ³ria devem ser considerados invĆ”lidos.
  • O pipeline de docs em .github/workflows/docs.yml executa geraĆ§Ć£o de snapshot + build + deploy para GitHub Pages.
  • Para o deploy de docs funcionar, os secrets SUPABASE_URL e SUPABASE_SERVICE_ROLE_KEY devem existir no repositĆ³rio (Settings ā†’ Secrets and variables ā†’ Actions).

OperaĆ§Ć£o

  1. Atualize os arquivos de especificaĆ§Ć£o em /docs.
  2. Gere snapshot local (quando necessƔrio): bash node scripts/generate-schema-snapshot.js
  3. Valide o build: bash mkdocs build