Contribuir com a documentação do Weblate

Você é bem-vindo para melhorar a página de documentação de sua escolha. Faça isso facilmente clicando no botão Editar no GitHub no canto superior direito da página.

Diretrizes na documentação

Respeite essas diretrizes ao escrever:

  1. Não remova parte da documentação se ela for válida.

  2. Use uma linguagem clara e de fácil compreensão. Você está escrevendo documentos técnicos, não um poema. Nem todos os leitores de documentos são falantes nativos, fique atento.

  3. Não tenha medo de perguntar se você não tem certeza. Se você tiver que perguntar sobre algum recurso durante a edição, não altere seus documentos antes de ter a resposta. Isso significa: você muda ou pergunta. Não faça os dois ao mesmo tempo.

  4. Verifique suas alterações executando as ações descritas ao seguir os documentos.

  5. Envie PR com alterações em pequenos pedaços para tornar mais fácil e rápido revisar e mesclar.

  6. Se você quiser reescrever e alterar a estrutura de um grande artigo, faça isso em duas etapas:

    1. Reescreva

    2. Depois que a reescrita for revisada, polida e mesclada, altere a estrutura dos parágrafos em outro PR.

Criar documentação localmente

A documentação também pode ser editada e criada localmente; os requisitos do Python estão no grupo de dependência docs em pyproject.toml. A compilação pode ser executada usando ci/run-docs.

Dica

Você também precisará do graphviz instalado para criar a documentação.

Traduzir a documentação

Você pode traduzir os documentos.

Documentação para permissões, verificações, complementos e sugestões automáticas

Várias seções de documentação usam modelos gerados a partir do código. Os seguintes comandos de gerenciamento estão disponíveis:

Todos esses comandos geram o reStructuredText, que é usado como modelo para a documentação. A maneira mais fácil de aplicar alterações na documentação é usar o visual “diff” em seu editor.