Bem-vindo à documentação do Prisma Prime Market API!

• ARCHITECTURE.md - Arquitetura detalhada do sistema
• API.md - Documentação da API REST
• PROJECT_STRUCTURE.md - Estrutura de diretórios
• CONTRIBUTING.md - Guia de contribuição

• AI_INTEGRATION.md - Integração com IA (PostgreSQL + pgvector)

• CI_CD_SUMMARY.md ⭐ COMECE AQUI!
  Resumo executivo - tudo que você precisa saber em 5 minutos

• CI_CD_IMPLEMENTATION.md
  O que foi implementado e como funciona

• CI_CD_SETUP.md
  Passo a passo completo para configurar o pipeline

• QUICK_REFERENCE.md
  Comandos úteis, git workflow, troubleshooting

• CI_FLOWCHART.md
  Diagramas ASCII dos workflows e processos

• adr/001-architecture-style.md - Escolha da arquitetura
• adr/002-database-choice.md - Escolha do banco de dados

1. Leia: CI_CD_SUMMARY.md
2. Configure: CI_CD_SETUP.md
3. Consulte: QUICK_REFERENCE.md
4. Contribua: CONTRIBUTING.md

1. Revise: ARCHITECTURE.md
2. Entenda: CI_CD_IMPLEMENTATION.md
3. Veja decisões: adr/
4. Configure: CI_CD_SETUP.md

1. Comece: CI_CD_SUMMARY.md
2. Entenda a arquitetura: ARCHITECTURE.md
3. Veja o pipeline: CI_CD_IMPLEMENTATION.md
4. Explore o código: ../src/

1. Leia: CI_CD_IMPLEMENTATION.md
2. Configure: CI_CD_SETUP.md
3. Workflows: ../.github/workflows/
4. Fluxos: CI_FLOWCHART.md

ARCHITECTURE.md           → Visão geral da arquitetura
PROJECT_STRUCTURE.md      → Estrutura de diretórios
adr/                      → Decisões arquiteturais documentadas

API.md                    → Documentação dos endpoints
(Swagger quando rodando)  → Documentação interativa

CI_CD_SUMMARY.md          → 📌 Resumo executivo (START HERE)
CI_CD_IMPLEMENTATION.md   → O que foi implementado
CI_CD_SETUP.md            → Como configurar
QUICK_REFERENCE.md        → Comandos úteis
CI_FLOWCHART.md           → Fluxogramas visuais
../.github/workflows/     → Código dos workflows

CONTRIBUTING.md           → Como contribuir
QUICK_REFERENCE.md        → Comandos Git e convenções
CI_FLOWCHART.md           → Conventional Commits

• Entender a arquitetura → ARCHITECTURE.md
• Configurar CI/CD → CI_CD_SETUP.md
• Fazer um commit → QUICK_REFERENCE.md
• Criar um PR → CONTRIBUTING.md
• Executar testes → QUICK_REFERENCE.md
• Entender um workflow → ../.github/workflows/README.md
• Ver fluxos visuais → CI_FLOWCHART.md
• Comandos rápidos → QUICK_REFERENCE.md

• Clean Architecture → ARCHITECTURE.md
• DDD → ARCHITECTURE.md
• SOLID → ARCHITECTURE.md
• Design Patterns → ARCHITECTURE.md
• CQRS → ARCHITECTURE.md + QUICK_REFERENCE.md
• Response Pattern → API.md + QUICK_REFERENCE.md
• PostgreSQL + pgvector → AI_INTEGRATION.md
• GitHub Actions → CI_CD_IMPLEMENTATION.md
• Conventional Commits → CI_FLOWCHART.md
• CodeQL → CI_CD_SETUP.md

1. README.md principal
2. CI_CD_SUMMARY.md
3. QUICK_REFERENCE.md

4. ARCHITECTURE.md
5. CI_CD_IMPLEMENTATION.md
6. CI_CD_SETUP.md
7. CONTRIBUTING.md

8. PROJECT_STRUCTURE.md
9. API.md
10. AI_INTEGRATION.md
11. adr/ - Todos os ADRs
12. ../.github/workflows/ - Código dos workflows

1. README.md (principal)
2. CI_CD_SUMMARY.md
3. CI_CD_SETUP.md
4. Execute os passos de configuração
5. QUICK_REFERENCE.md para comandos

1. CONTRIBUTING.md
2. QUICK_REFERENCE.md (Git Workflow)
3. CI_FLOWCHART.md (Conventional Commits)
4. Faça seu código
5. Crie PR seguindo os padrões

1. ARCHITECTURE.md
2. PROJECT_STRUCTURE.md
3. adr/ (decisões relevantes)
4. Explore o código em src/

1. README.md (principal)
2. ARCHITECTURE.md
3. CI_CD_IMPLEMENTATION.md
4. CI_FLOWCHART.md (para slides visuais)

• .NET 8.0 Documentation
• GitHub Actions
• PostgreSQL
• pgvector

• Conventional Commits
• Semantic Versioning
• Keep a Changelog

• CodeQL
• Codecov
• OWASP

• Sempre atualize a documentação quando fizer mudanças significativas
• Documente decisões importantes em ADRs
• Mantenha exemplos atualizados e funcionais
• Use linguagem clara e evite jargões desnecessários

1. Documentação não está clara?
   Abra uma issue explicando o problema

2. Encontrou um erro?
   Faça um PR corrigindo

3. Falta algo?
   Sugira adições via issue

4. Tem dúvidas sobre implementação?
   Veja CONTRIBUTING.md e depois abra uma discussion

Mantenha a documentação viva! 📚✨

Última atualização: 2026-01-19
Versão: 1.0