Contribua para a documentação do Weblate

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

Documentation guidelines

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. Está a escrever 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 não tem certeza. Se tiver que perguntar sobre algum recurso durante a edição, não altere os documentos dele antes de ter a resposta. Isso significa: ou muda ou pergunta. Não faça os dois ao mesmo tempo.

  4. Verifique as suas alterações a executar 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 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.

Building the documentation locally

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

Também precisará do graphviz instalado para criar a documentação.

Translating the documentation

Pode traduzir os documentos.

Documenting permissions, checks, add-ons and automatic suggestions

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

Todos estes 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» no seu editor.