Escrever documentação¶

Estes são os passos a seguir para escrever sua contribuição de documentação para BeeWare.

Antes de começar a escrever a documentação, certifique-se de que é capaz de compilar a documentação e que está a trabalhar num ramo.

Atualizar a documentação existente¶

Se estiver a editar os documentos existentes, será necessário localizar o ficheiro no diretório /docs/en. A estrutura do ficheiro segue a estrutura da página, assim pode localizar o ficheiro usando o URL da documentação.

Adicionar nova documentação¶

Se estiver a adicionar um novo documento, há mais alguns passos envolvidos.

Vai precisar criar o documento no local apropriado dentro do diretório docs/en. Para fins de discussão, digamos que esteja a adicionar um novo documento com o nome de ficheiro new_doc.md.

Depois, vai precisar atualizar o ficheiro docs/en/SUMMARY.md para incluir o novo ficheiro. O SUMMARY.md é organizado para refletir basicamente a estrutura do diretório docs/en, mas, o que é mais importante, determina diretamente a estrutura da barra lateral esquerda. Se localizar a secção onde pretende incluir o new_doc.md, não vai precisar alterar nada no SUMMARY.md caso veja um caminho com wildcard listado. Por exemplo:

-./caminho/para/diretório/*

Se a secção em que pretende incluir new_doc.md for uma lista de atalhos Markdown individuais, será necessário adicionar um atalho explícito para o seu. Por exemplo:

-[Meu novo documento](new_doc.md)

Escrever a sua documentação¶

Agora pode abrir o ficheiro desejado no seu editor, e começar a escrever.

Temos um guia de estilo de documentação que descreve as nossas diretrizes para escrever documentação para o BeeWare.

Quando estiver satisfeito com a sua nova documentação, pode submeter um pedido de puxar com as suas alterações propostas.