Carbon Free — Ecossistema¶
Documentação cross-cutting da plataforma. Cobre o que vive entre os 4 repos, não dentro de cada um.
Doc específica de cada componente fica no MkDocs do próprio repo (linkados abaixo).
Componentes¶
| Repo | O que faz | Doc própria |
|---|---|---|
api-carbon-free |
Backend monolítico — domínios, autenticação, orquestração | docs |
Carbon_Free_Cliente |
Frontend web (React) | — |
lambda_chunk_processor |
Consome SQS, baixa chunk do S3, invoca GHG Lambda, persiste | — |
calculo_automatizado_ghg |
Cálculo de emissões GEE em Lambda separada | — |
Comece por aqui¶
- Visão geral do ecossistema — os 4 componentes e como se conectam.
- Pipeline de submissão — fluxo end-to-end de uma submissão grande passando pelos 3 backends.
- Ambientes — URLs de staging, prod e local.
O que NÃO vive aqui¶
- Documentação de um único repo (vai no MkDocs daquele repo).
- ADRs de um único componente (vai em
docs/decisoes/do repo dono). - Runbooks operacionais sensíveis (Notion privado).
- Convenções de PR, branch, commit de um repo específico (README ou docs do repo).
Esta doc é cross-cutting — entra coisa só quando atravessa 2+ repos ou não tem dono natural.