Base do projeto/docs/guia
Como usar a documentação
Este mini site organiza o acervo técnico do projeto em camadas com objetivos diferentes. A ideia é permitir navegação rápida por tema, sem depender de conhecer a árvore do repositório.
Recorte da seçãoBase estrutural do projeto
Nota de referência para contratos, arquitetura, runbook e organização do workspace. É a camada mais estável da documentação.
Atualizado15 de abr. de 2026
Seções4
Tags0
O que cada área entrega
- Início: visão geral do acervo, entradas principais e acesso rápido às trilhas do projeto.
- Base do projeto: notas mais estáveis sobre arquitetura, runtime, persistência, runbook e organização do workspace.
- Guias técnicos: explicações orientadas por fluxo, com ordem de execução, contexto e trechos reais do código.
- Slides: material mais curto para apresentação, treinamento ou revisão rápida.
Quando entrar em cada uma
- Se o objetivo é entender o mapa geral do sistema, comece por 00 - Inicio.
- Se a necessidade é localizar contratos, decisões estruturais ou operação recorrente, siga pela base principal das notas.
- Se o objetivo é explicar ou revisar uma feature ponta a ponta, entre por README.
- Se o foco é montar roteiro de apresentação ou apoio visual, use README.
- Se a necessidade é alinhar próximos ciclos, arquitetura alvo, VPS, banco e mobile, entre por 11 - Roadmap de Plataforma e Escalabilidade.
- Se a necessidade é implantar o banco, operar o
Data Studioe validar o ambiente, siga por 13 - Implantacao Inicial do Banco, 14 - Operacao do Data Studio e 15 - Checklist Pos-Provisionamento. - Se a necessidade é entender como produtos entram no painel, na API e no storefront, siga por 16 - Catalogo - Operacao e 21 - Catalogo - Painel API e Storefront.
- Se a necessidade é operar o cadastro de produto no dia a dia, siga por 22 - Painel - Cadastro de Produto.
- Se a necessidade é entender a jornada da área do cliente e a evolução planejada de
Minha conta, siga por 23 - Ecommerce - Minha Conta. - Se a necessidade é operar clientes pelo admin, sem depender do fluxo do ecommerce, siga por 25 - Painel - Clientes.
- Se a necessidade é revisar a malha logistica, simulacao de prazo e como o pedido grava o recorte operacional de entrega ou retirada, siga por 30 - Logistica - Operacao e Simulacao.
- Se a necessidade é revisar a arquitetura de autenticação e proteção da conta do cliente, siga por 26 - Ecommerce - Auth e Seguranca.
- Se a necessidade é controlar chaves, escopos e a API autenticada de integração, siga por 27 - APIs de Integracao e Chaves.
- Se a necessidade é revisar exclusão, anonimização e retenção mínima de dados do cliente, siga por 28 - LGPD - Conta do Cliente e Retencao.
- Se a necessidade é entender o percentual de cobertura atual do produto e o que ainda falta para operação comercial mais completa, siga por 29 - Snapshot de Cobertura e Maturidade.
Como navegar melhor
- Use a busca do topo para localizar módulos, APIs, rotas e termos do projeto.
- Use a sidebar quando quiser percorrer a documentação por seção.
- Use os links entre notas para seguir uma trilha de leitura contínua.
Observação
Esse acervo resume e reorganiza a documentação técnica existente. As fontes detalhadas continuam em README.md e em docs/.