Documentação — Covil do Mineiro
Esta pasta é a fonte da verdade da documentação do projeto. É escrita em
Markdown, versionada no Git e (na Fase 2) publicada em
docs.atleticacovildomineiro.com.br via Fumadocs.
Se você é uma IA ou acabou de chegar ao projeto, comece por
../AGENTS.md.
Índice
Entender o projeto
arquitetura.md— como o sistema é montado (camadas, fronteira server/client, integrações).banco-de-dados.md— tabelas, RLS, funçõesSECURITY DEFINERe migrations.seguranca.md— modelo de segurança em duas camadas (guarda + RLS) e regras invioláveis.
Operar
setup.md— rodar o projeto localmente do zero.deploy.md— Vercel, variáveis de ambiente/segredos e migrations em produção.runbooks/— procedimentos recorrentes (aprovar sócio, aplicar migration, girar segredo).
Padrões (obrigatórios)
ui-content-standard.md— padrão de UI pública e de copy.admin-standard.md— padrão do backoffice.
Decisões e histórico
decisoes/— ADRs (Architecture Decision Records): o porquê das escolhas.sistema-pontos-socios.md— brief/spec original do programa de Pepitas (histórico — já implementado).
Como manter esta documentação
- Documento desatualizado é pior que documento ausente. Ao mudar comportamento, atualize o doc correspondente no mesmo PR.
- Decisões de arquitetura viram um ADR novo em
decisoes/(não reescreva a história — registre a mudança). - Use caminhos relativos para links de arquivos (
../src/...), nunca caminhos absolutos de máquina.