Índice da pasta docs/. O cartão de visita do repositório (README, licença,
contribuição, segurança, changelog) fica na raiz.
Última revisão: 19/09/2026.
Como esta pasta está organizada
| Pasta | O que entra | Pode apagar? |
|---|
| operacao/ | Setup, onboarding, deploy, runbooks, testes | Não — guias vivos |
| arquitetura/ | C4, ADRs, modelo de dados, fluxos de módulo, integrações | Não — fonte da verdade |
| api/ | Contrato HTTP, catálogo de endpoints, OpenAPI | Não — contrato vivo |
| seguranca/ | RBAC, matriz de flags, hardening | Não — autorização vigente |
| front/ | Design system, mapa do dashboard, fluxos de UI | Não — padrão visual/UX |
| extra/ | Demanda pontual, dump de chat, auditoria datada | Sim — ver extra/README.md |
Documento novo: coloque na pasta do tema. Se for só o recorte de um chat ou
uma auditoria de um dia, vá para extra/ — assim fica óbvio o que pode sair.
Comece por aqui
| Documento | Quando usar |
|---|
| ../README.md | O que é, como subir, comandos |
| operacao/setup.md | Instalação completa (PHP, Docker, migrations, env) |
| operacao/onboarding.md | Primeiro dia de um dev novo |
| arquitetura/arquitetura.md | C4, camadas, integrações, decisões vigentes |
| api/README.md | Contrato HTTP, auth, CSRF, envelope JSON |
| api/endpoints.md | Catálogo de todos os endpoints |
| api/openapi.yaml | OpenAPI 3.0 gerado a partir de backend/api |
Operação
Arquitetura e domínio
Segurança e autorização
Front
Integração PayUp (guias do provedor): backend/src/integrations/payup/.