# Índice da documentação técnica (NoLapis)

Mapa dos arquivos **`Doc_*.md`** na raiz do repositório e materiais em **`docs/`**. Convênio de nomes: **`Doc_Modulo_<Área>.md`** (domínio ERP), **`Doc_Jobs_e_Agendamento.md`** (fila + scheduler), **`Doc_INDICE.md`** (este arquivo).

---

## Documentos por arquivo

| Documento | Conteúdo resumido |
|-----------|-------------------|
| **`Doc_INDICE.md`** | Índice e lacunas conhecidas. |
| **`Doc_Cloudflare.md`** | DNS, SSL, variáveis `.env` e integração Laravel atrás do Cloudflare. |
| **`Doc_NewRelic.md`** | Nome único APM/Browser, `.env`, `newrelic.ini` e remoção de entidades duplicadas. |
| **`Doc_Inventario_Repositorio.md`** | Inventário transversal do repositório (stack, rotas, models, services, módulos, status, lacunas, checklist ERP). Atualizar quando a arquitetura ou o escopo do código mudar de forma relevante. |
| **`Doc_Analise_Concorrencia_e_GTM.md`** | Análise competitiva (Omie, Bling, Conta Azul, Tiny, GestãoClick, MarketUP, Nibo), maturidade por módulo, riscos, GTM, backlog e posicionamento. Usar legenda Código/Mercado/Recomendado. Atualizar após mudanças estratégicas ou grandes releases. |
| **`Doc_Jobs_e_Agendamento.md`** | Job em fila (`ProcessarPontuacaoCampanhaJob`), comandos `assinatura:gerar-cobrancas` e `app:encerrar-campanhas-expiradas`, `Kernel` schedule. |
| **`Doc_Seeders_e_Dados_Iniciais.md`** | Classes em `database/seeders/`, `DatabaseSeeder`, gatilhos (`TenantObserver`, `FluxoController`), migrations que inserem dados. |
| **`Doc_Modulo_Dashboards.md`** | Visão geral, **DFC**, **DRE gerencial** (gate `plano.funcionalidade`), extrato/movimentação, financeiro legado (KPIs), conciliação (rotas), veículo, produto, evento, tags, ranking campanhas. |
| **`Doc_Modulo_Contrato.md`** | Contratos, itens, veículos, recorrência, `ContratoService` / comando de cobrança. |
| **`Doc_Modulo_Evento.md`** | Eventos, agenda, calendário, timetracking, vínculo opcional com `nfitem`. |
| **`Doc_Modulo_Financeiro.md`** | NF, parcelas, vendas, pedidos, compras, fluxo, transferência entre contas, cartão/fatura, conciliação, integração evento/contrato, PDV (formas), pontuação por NF. |
| **`Doc_Modulo_PDV.md`** | Tela `/PDV`, Livewire, `PdvNfService`, caixa, `nf.idcaixa`, cancelamento `pdv_*`. |
| **`Doc_Modulo_Pessoa_Usuario.md`** | `pessoa`, usuários, Spatie Permission, login SSO (Google/Microsoft), forgot password (Brevo). |
| **`Doc_Modulo_Planos_Assinatura_Pagamento.md`** | Planos, upgrade, cupons, cadastro externo (senha/SSO), assinatura SaaS, Pagar.me. |
| **`Doc_Modulo_Assinatura_Contrato.md`** | Contrato `RECORRENCIA`, provisionamento, dashboard Assinaturas, churn. |
| **`Doc_Modulo_Produto_Servico.md`** | Hierarquia contábil (4 níveis), **`linhadre`**, classificação DRE/DFC (`tipo_fluxo` FCO/FCI/FCF), `ProdutoServico`, estoque, fiscal. |
| **`Doc_Modulo_Status_Fluxo_Cores.md`** | `FluxoService`, status configuráveis, cores na UI. |
| **`Doc_Modulo_Tags.md`** | Tags, tipos, retiradas, dashboard de tags. |
| **`Doc_Modulo_Tenant.md`** | Multi-tenant, `TenantScope`, provisionamento, política de autenticação da instância. |
| **`Doc_Modulo_Catalogo_Padrao.md`** | Catálogo padrão multi-tenant (`tabela_padrao`), sync, uso, exclusão `EXCLUIDO`, admin e CLI. |
| **`Doc_Modulo_Veiculo.md`** | Veículos, frota, integração com evento/NF onde aplicável. |
| **`Doc_Modulo_Caixa_Entrada_Fiscal.md`** | **Fase 1:** certificado A1 por empresa, consulta DistDFe (NF-e/CT-e), classificação, listagem/detalhe, job diário; Fase 2: vínculo com compras/vendas. |
| **`docs/comparacao-pacotes-status.md`** | Comparação pontual de pacotes/status (fora do prefixo `Doc_`). |
| **`docs/planos-site-wordpress.md`** | Tabela comparativa e CTAs de planos para o site institucional (WordPress). |

---

## Lacunas conhecidas (código admin sem `Doc_Modulo` dedicado)

Controllers e áreas presentes em **`app/Http/Controllers/Admin/`** que **não** têm documento de módulo próprio na raiz; parte do comportamento pode estar citada de passagem em Financeiro, Produto ou Jobs:

| Área | Arquivos / observação |
|------|------------------------|
| **Campanhas (marketing / pontos)** | `CampanhaController`, models de campanha, `RankingCampanha` Livewire, `ProcessaPontuacaoCampanha` — automação e fila em **`Doc_Jobs_e_Agendamento.md`**; **CRUD e regras de negócio da campanha** não estão em um `Doc_Modulo_Campanha`. |
| **Obras** | `ObraController` — sem doc dedicada. |
| ~~**Importação NFe**~~ | Comportamento de import manual descrito em **`Doc_Modulo_Caixa_Entrada_Fiscal.md`** (§ reutilização) e Financeiro; `NfeImportadorController` permanece para upload pontual. |
| ~~**Transferências entre contas**~~ | Coberto em **`Doc_Modulo_Financeiro.md`** § 1.4.1 (`TransferenciaController`). |
| ~~**Dashboards DFC/DRE**~~ | Coberto em **`Doc_Modulo_Dashboards.md`** § 4–5. |
| ~~**Dashboards**~~ | Coberto em **`Doc_Modulo_Dashboards.md`** (extrato, DFC, DRE, visão geral). |
| **Utilitários / apoio** | `PaletaCorController`, `FileUploadTraitController`, `PermissionController` (permissões podem estar só em Pessoa/Usuário). |
| ~~**CTN / tributação**~~ | Entidade global do catálogo — ver **`Doc_Modulo_Catalogo_Padrao.md`** § 3 e **`Doc_Modulo_Produto_Servico.md`** (fiscal). |

**Livewire:** dezenas de componentes (`CommandPalette`, `CompraComponent`, etc.) sem catálogo próprio; o relevante ao PDV está em **`Doc_Modulo_PDV.md`**.

**Migrations:** não há registro centralizado; mudanças de schema importantes devem ser mencionadas no módulo afetado (ex.: **`nf.idcaixa`** citado no Financeiro e no PDV).

---

*Atualize este índice ao criar novos `Doc_*.md` ou ao cobrir uma lacuna acima.*