Skip to content

Guia para Contribuidores

Referência principal: AGENTS.md na raiz do repositório.

Este resumo destaca os pontos essenciais para manter a documentação consistente:

Estrutura

  • Todo o conteúdo permanece em Markdown. Não adicione código de produção.
  • Utilize docs/<módulo>/ para tópicos específicos e docs/snippets/ para diagramas reutilizáveis.
  • Atualize README.md e o índice do VitePress sempre que criar novas páginas.

Qualidade e Validação

  • Rode npm run lint:md e npm run lint:links antes de abrir PR.
  • Para revisar o site localmente, execute npm install seguido de npm run docs:dev.
  • Para gerar o build estático, execute npm run docs:build.

Convenções

  • Cabeçalhos ATX, parágrafos curtos, linhas até ~100 caracteres.
  • Use blocos de código apenas para exemplos ilustrativos.
  • Diagramas devem estar em fenced blocks ```text.

Para instruções completas (commits, fluxos de trabalho, padrões de escrita), leia o arquivo AGENTS.md.

Documentação privada do ecossistema Filament Core.