Conn2Flow
Navegação das docs

SDD

Requisição 182 — Documentação do Core: Guias e Referência de CLI e API (FEAT-014, fase 2, onda 4)

Origem: Humano, 2026-09-26: dividir o que falta da req-179 em uma requisição por onda, cada uma para um agente em outra infraestrutura. Ondas irmãs: req-183 (onda 5, conceitos e…

Origem: Humano, 2026-09-26: dividir o que falta da req-179 em uma requisição por onda, cada uma para um agente em outra infraestrutura. Ondas irmãs: req-183 (onda 5, conceitos e novidades) e req-184 (onda 6, publicação do SDD e pipeline). Lote Vinculado: BATCH-186. Status: approved. Autonomia: Nível 2. Commit e push autorizados pelo Humano. Sem pipeline e sem deploy: a publicação no Lab é do agente da req-184. Leitura obrigatória antes de começar:

  • skill c2f-documentation;

  • req-179.md: regras (§1) e mapa (§2.4);

  • ai-workspace/pt-br/docs/guides/documentation.md (o contrato, inclusive a chave label);

  • BATCH-184.md: achados já registrados;

  • exemplos do rigor esperado: guides/installation.md, concepts/resources.md, reference/libraries/cron.md.


1. Premissa (Humano)

As docs legadas foram escritas por uma geração anterior de agentes, que errava muito. Parta do princípio de que toda doc legada está errada e refaça a partir do código. Use os comentários do código (req-xxx, DEC-xxx), mas confirme cada afirmação lendo a implementação; quando possível, rode (c2f <comando> --help, php -r). Há muita coisa implementada sem documentação, e ela também deve entrar.

2. Escopo (pt-br e en, mesmo caminho, na mesma passagem)

Doc nova Legado a ler (pista, não fonte) e apagar ao migrar (+ equivalente en)
guides/development-environment.md (ambiente local, Docker, Cloudflare Tunnel, PHP 8.5) CONN2FLOW-AMBIENTE-DESENVOLVIMENTO, CONN2FLOW-AMBIENTE-DOCKER, CONN2FLOW-CLOUDFLARE-TUNNEL, en PHP85-INSTALL-GUIDE
guides/dev-tools-vscode.md GUIA-PAINEL-DEV-TOOLS-VSCODE
guides/ci-cd.md (workflows de release do repositório) CONN2FLOW-GITHUB-ACTIONS
guides/create-a-module.md — (baseie-se em reference/modules/menus.md e no c2f de scaffolding, se houver)
guides/create-a-plugin.md CONN2FLOW-PLUGIN-INSTALADOR-FLUXO
guides/deploy-a-project.md (pipeline project:update-all, modos de deploy, cron no servidor, sitemap) CONN2FLOW-AUTOMACAO-EXPORTACAO, CONN2FLOW-HISTORICO-EXPORTACAO
reference/cli/index.md + uma página por grupo de comandos (cli/src/Commands/, 52 arquivos; docs:*, project:*, resources:*, css:*, db:*, assets:*, ai:*…) —
reference/api/index.md + páginas por grupo de endpoints (gestor/controladores/api/: autenticação OAuth2, project/*, módulo distribuído, gateways) —

Achados que devem entrar (detalhes no BATCH-184): nada cria o agendamento do cron no servidor (reference/libraries/cron.md); o deploy não atualiza o sitemap.xml (reference/libraries/sitemap.md); e-mail só com SMTPS/porta 465 (reference/libraries/comunicacao.md); o scope dos tokens da API não é aplicado (reference/libraries/oauth2.md). Para segurança, aponte para a req-181 sem repetir detalhes de exploração.

3. Regras de convivência (obrigatórias)

  1. Só edite ai-workspace/{pt-br,en}/docs/guides/ (exceto installation.md e documentation.md, salvo correção de link), reference/cli/, reference/api/, os legados da tabela §2 e sdd/implementation/BATCH-186.md. Os índices (BATCH-INDEX.md, CURRENT.md, VALIDATION-CHECKLIST.md) são do agente da req-179.

  2. Não rode c2f docs:build, project:update-all, css:rebuild nem resources:sync: o pipeline é exclusivo do agente da req-184. docs:audit e docs:extract podem ser rodados.

  3. Git: git fetch e git rev-list --count HEAD..origin/main antes de cada push (se houver commits novos, git pull --rebase só com a sua árvore limpa); git add só com os seus caminhos (nunca -A nem .); commits pequenos com docs(core): <escopo> (BATCH-186 / req-182) e a linha Co-Authored-By; push após cada commit.

  4. Heredoc do Git Bash corrompe barras invertidas e aspas. Use as ferramentas de arquivo (Write/Edit) ou um script salvo em arquivo.

  5. Links só para .md existentes; link quebrado aborta o build. Nada de link "provisório".

  6. Conteúdo público: sem hosts, IPs, credenciais ou caminhos de servidor reais.

4. Critério de aceite

  1. docs:audit --json: 0 erros e nenhum item de guides/, reference/cli/ ou reference/api/ com score > 0.

  2. Legados da tabela §2 apagados nos dois idiomas.

  3. BATCH-186.md com as docs, os achados do código por doc e os hashes dos commits.

O Futuro é Híbrido: Humano + IA.

O Conn2Flow é a ferramenta. Se você precisa do Arquiteto para desenhar a estratégia da sua empresa usando essa tecnologia...

Contrate Consultoria Especializada