Origem: Humano, 2026-09-25: dividir a revisão da documentação entre dois agentes. Este intake é a parte do segundo agente. A req-179 (BATCH-184) segue com o primeiro agente: bibliotecas, guias e conceitos.
Lote Vinculado: BATCH-185.
Status: approved.
Autonomia: Nível 2. Commit e push autorizados pelo Humano. Sem deploy: a publicação no Lab é feita pelo outro agente (ver §4).
Leitura obrigatória antes de começar:
-
skill
c2f-documentation; -
req-179.md (mapa §2.2 e regras §1);
-
ai-workspace/pt-br/docs/guides/documentation.md(o contrato); -
os exemplos prontos:
ai-workspace/pt-br/docs/reference/modules/menus.md(módulo) ereference/libraries/banco.md(nível de rigor esperado).
1. Premissa (Humano)
As docs atuais 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. O código tem comentários ricos (req-xxx, DEC-xxx, o porquê das decisões): use-os, mas confirme cada afirmação lendo a implementação. Há muita coisa implementada sem documentação nenhuma, e ela também deve entrar.
2. Escopo: uma doc por módulo, em reference/modules/<id>.md, pt-br e en
| Módulo | Legado a ler (pista, não fonte) e APAGAR ao migrar |
|---|---|
admin-arquivos, admin-categorias, admin-componentes, admin-environment, admin-layouts, admin-modos-ia, admin-paginas, admin-prompts-ia, admin-templates, contatos, dashboard, modulos, modulos-grupos, modulos-operacoes, publisher, publisher-pages, usuarios, usuarios-perfis, variables |
pt-br/docs/modulos/<id>.md, pt-br/docs/manual/modulos/<id>.md e os equivalentes em en/docs/modulos/ e en/docs/manual/modulos/ |
admin-atualizacoes |
modulos/admin-atualizacoes.md + manual/modulos/atualizacoes.md |
admin-ia |
modulos/admin-ia.md + manual/modulos/recursos-ia.md |
admin-plugins |
modulos/admin-plugins.md + manual/modulos/plugins.md |
perfil-usuario |
modulos/perfil-usuario.md + modulos/PERFIL-USUARIO-SIGNUP-HOOKS.md (en: USER-PROFILE-SIGNUP-HOOKS.md) + manual/modulos/meu-perfil.md |
forms |
modulos/forms.md |
admin-cron, forms-search, forms-submissions, galleries, interface, pages-index, publisher-highlights, publisher-index |
nenhum (doc nova) |
| — | Apagar também manual/modulos/{componentes,layouts,paginas,templates}.md (fundidos nos admin-*) e os README.md de modulos/, manual/ e manual/modulos/, quando todos os módulos estiverem migrados |
menus já está feito (piloto). Não mexa nele.
3. Conteúdo de cada doc de módulo
Siga o formato de reference/modules/menus.md:
-
Frontmatter com
section: reference,module: <id>,sources(todos os arquivos lidos:.php,.json,.js,.widget.php, migrations da tabela) everified_at=git rev-parse --short HEADno momento da conferência. -
O que é e para que serve (1 parágrafo).
-
Como usar: o fluxo do operador no painel, com as rotas reais de
resources/<idioma>/pagesdo JSON do módulo. Substitui o antigo "manual do usuário". -
Referência técnica:
-
opções do
switch($_GESTOR['opcao'])e doswitch($_GESTOR['ajax-opcao']); -
tabela(s) e colunas (da migration);
-
estrutura de JSONs como
fields_schema; -
widget público (marcador
<!-- widgets#<id>->render(...) -->, blocos e variáveis do template); -
templates que acompanham o módulo;
-
hooks e API (
hooks.apino JSON); -
permissões e operações (
modulos_operacoes).
-
-
Comportamentos surpreendentes, defeitos e legado: o que o código faz de diferente do que a doc antiga dizia, funções sem chamador, riscos de segurança (SQL sem escape, visibilidade que não é controle de acesso…). Use callouts
> [!WARNING]/> [!CAUTION]. -
Veja também com links relativos para
.mdexistentes. Link quebrado aborta o build.
Escreva pt-br e en na mesma passagem, com o mesmo conteúdo e o mesmo caminho.
4. Regras de convivência com o outro agente (obrigatórias)
-
Só edite
ai-workspace/{pt-br,en}/docs/reference/modules/, os arquivos legados de módulo listados em §2 esdd/implementation/BATCH-185.md. Não editereference/libraries/,guides/,concepts/,index.md,sdd/human-requests/CURRENT.md,sdd/implementation/BATCH-INDEX.mdnemsdd/validation/VALIDATION-CHECKLIST.md: quem atualiza os índices é o outro agente. Registre tudo noBATCH-185.md. -
Não rode
c2f docs:build,project:update-all,css:rebuildnemresources:sync. O pipeline não pode rodar em paralelo, e a publicação no Lab é feita pelo outro agente. -
Pode rodar
php cli/c2f.php docs:audit(só leitura) ephp cli/c2f.php docs:extract(não se aplica a módulos). -
Git:
-
antes de cada commit,
git pull --rebase origin main; -
git addsó com os seus caminhos (nunca-A, nunca.); -
commits pequenos, por lote de 3 a 5 módulos, com a mensagem
docs(modules): <ids> reescritos do codigo (BATCH-185 / req-180)e a linhaCo-Authored-Bydo agente; -
push após cada commit.
-
-
Heredoc do Git Bash corrompe barras invertidas. Para escrever ou editar arquivos, use as ferramentas de arquivo (Write/Edit), nunca
cat <<EOFnem Python via heredoc.
5. Critério de aceite
-
php cli/c2f.php docs:audit --jsonsem nenhum itemreference/modules/*com score > 0 e semmissing:reference/modules/*. -
Os arquivos legados de §2 apagados (pt-br e en).
-
BATCH-185.mdcom a lista de módulos, os achados relevantes do código por módulo (defeitos, legado, divergências da doc antiga) e os hashes dos commits.
6. Ordem sugerida
Os mais usados primeiro:
-
admin-paginas,publisher,publisher-pages,publisher-index,publisher-highlights,pages-index; -
forms,forms-submissions,forms-search,galleries; -
perfil-usuario,usuarios,usuarios-perfis,modulos,modulos-grupos,modulos-operacoes; -
o resto.