Redação de documentação

Estas são as etapas a serem seguidas para escrever sua contribuição de documentação para BeeWare.

Antes de começar a escrever a documentação, certifique-se de que você é capaz de compilar a documentação e que está trabalhando em um branch.

Atualização da documentação existente

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

Adição de nova documentação

Se você estiver adicionando um novo documento, há mais algumas etapas envolvidas.

Você precisará criar o documento no local apropriado dentro do diretório docs/en. Para fins de discussão, digamos que você esteja adicionando um novo documento com o nome de arquivo new_doc.md.

Em seguida, você precisará atualizar o arquivo docs/en/SUMMARY.md para incluir o novo arquivo. 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 você localizar a seção onde pretende incluir o new_doc.md, não precisará alterar nada no SUMMARY.md caso veja um caminho curinga listado. Por exemplo:

- ./path/to/directory/*

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

- [My new document](new_doc.md)

Escrevendo sua documentação

Agora você pode abrir o arquivo desejado em seu editor e começar a escrever.

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

Quando estiver satisfeito com sua nova documentação, você pode enviar uma solicitação pull com as alterações propostas.