Skip to content

Atualiza documentacao dos modulos - #83

Merged
bryancalvarenga merged 1 commit into
mainfrom
codex/update-readmes
May 21, 2026
Merged

Atualiza documentacao dos modulos#83
bryancalvarenga merged 1 commit into
mainfrom
codex/update-readmes

Conversation

@diasgarcia

@diasgarcia diasgarcia commented May 17, 2026

Copy link
Copy Markdown
Collaborator

Resumo

  • README.md — reduza para visao geral do monorepo, arquitetura, comandos de inicio e links para docs tecnicas.
  • api/README.md — detalhe stack, arquitetura, endpoints, migrations, modelo de dados, decisoes de DB e padroes de implementacao.
  • api/docs/database-model.md — atualize o modelo para V1..V13, 16 tabelas, password_reset_tokens, campos de perfil da loja e products.available.
  • api/dados/README.md — atualize seeds de desenvolvimento, IDs fixos e uso da collection Postman.
  • web/README.md — detalhe rotas, estrutura Next.js, client HTTP, sessao, validacoes, testes e contrato de data-testid.
  • automations/README.md — crie documentacao tecnica com metricas atuais, projetos Playwright, tags, padroes de pages/services e validacao de banco com toPass.

Test plan

  • Revisar README.md — deve ficar como mapa rapido do projeto e explicar como iniciar banco, API, web e automacoes.
  • Revisar api/README.md e api/docs/database-model.md — devem refletir migrations V1 a V13, 16 tabelas e os campos novos de loja/produto.
  • Revisar web/README.md — deve explicar rotas, env, API client e testes do frontend.
  • Revisar automations/README.md — deve explicar metricas, projetos Playwright, tags e padroes de implementacao.
  • Confirmar que nenhum arquivo de codigo foi alterado.

@diasgarcia diasgarcia self-assigned this May 17, 2026
@diasgarcia
diasgarcia requested review from bryancalvarenga and removed request for bryancalvarenga May 20, 2026 03:50
@bryancalvarenga
bryancalvarenga merged commit c41f2d1 into main May 21, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants