Próximo: , Anterior: , Acima: Contribuindo   [Conteúdo][Índice]

22.18 Escrevendo documentação

Guix é documentado usando o sistema Texinfo. Se você ainda não está familiarizado com ele, aceitamos contribuições para documentação na maioria dos formatos. Isso inclui texto simples, Markdown, Org, etc.

Contribuições de documentação podem ser enviadas para guix-patches@gnu.org. Adicione ‘[DOCUMENTATION]’ ao assunto.

Quando você precisar fazer mais do que uma simples adição à documentação, preferimos que você envie um patch adequado em vez de enviar um e-mail como descrito acima. Veja Enviando patches para obter mais informações sobre como enviar seus patches.

Para modificar a documentação, você precisa editar doc/guix.texi e doc/contributing.texi (que contém esta seção de documentação), ou doc/guix-cookbook.texi para o livro de receitas. Se você compilou o repositório Guix antes, você terá muito mais arquivos .texi que são traduções desses documentos. Não os modifique, a tradução é gerenciada através de Weblate. Veja Traduzindo o Guix para mais informações.

Para renderizar a documentação, você deve primeiro certificar-se de que executou ./configure na sua árvore de origem (veja Executando guix antes dele ser instalado). Depois disso, você pode executar um dos seguintes comandos: