Documentação

Esta documentação fica no repositório gnoqcore-docs, em content/docs/**/*.mdx.

Quando atualizar

Atualize a documentação quando mudar:

• regra de negócio;
• endpoint;
• permissão;
• tela;
• fluxo de formulário;
• pipeline;
• variável de ambiente;
• integração;
• comportamento de auditoria, lixeira ou soft delete.

Como escrever

• Comece pela regra e pelo impacto, não pela classe.
• Use nomes do produto na primeira explicação.
• Só depois cite nomes técnicos de backend/frontend.
• Inclua endpoints quando eles ajudam a manutenção.
• Inclua caminhos de código quando o próximo desenvolvedor precisa achar rápido.
• Evite páginas longas que misturam produto, operação e implementação sem separação.

Estrutura recomendada

Validação

Antes de publicar:

npm run verify