Contribuindo para Rust — documentação

Documentação nunca é boa o suficiente e nunca terá o bastante dela. Muitos aspectos da documentação do Rust não requere um conhecimento mais profundo para melhorar, escrever, revisar e editar a documentação, que são ótimas formas de aprender Rust. Além disso, melhoras na documentação são fáceis de identificar e não têm limites. Não gosta da forma da qual algo está escrito? Descobriu alguma informação não documentada? Sua pull request será muito apreciada.

A documentação mais impactante que você pode escrever é para pacotes que fazem parte do ecossistema Rust. Enquanto a documentação de dentro é relativamente completa, o mesmo não é verdade para a maioria dos pacotes e ferramentas populares que programadores Rust interagem todos os dias. Contribuindo documentação de APIs para um projeto Rust popular vai te recompensar com eterno amor de seu responsável.

O livro é a documentação primária para Rust, mantido no repositório principal. Ele tem seu próprio rótulo, A-book e está continuamente sendo refinado. Outras documentações no repositório principal incluem A referência para Rust, a Documentação da Biblioteca Padrão, O Rustonomicon (um guia para código inseguro em Rust, corretamente). O [Guia de Estilo de Rust][Rust Style Guide] está tão incompleto que ele não é referenciado com frequência; um contribuidor ambicioso pode se dar muito bem nele. O índice de erros fornece explicações extendidas para os erros que o compilador emite. Ao mesmo tempo que novos erros são adicionados, essa documentação precisa ser atualizada, então há sempre erros não indexados no índice prontos para serem adicionados. A maior parte da documentação interna vive na pasta src/doc. Tudo lá é regido pelo rótulo A-docs no seguidor de problemas. Finalmente, esse documento e outros materiais do website são mantidos no Repositório Git do website Rust. Para contribuir, simplesmente edite e mande uma pull request.

Uma grande quantidade de documentação importante para Rust não fica no repositório principal, ou não é mantido pelo projeto, mas ainda sim tem importância crítica para o sucesso de Rust. Exemplos de excelente documentação que está sendo ativamente desenvolvida e com necessidade de contribuidores inclui Rust por Exemplos (inglês), Padrões de Design para Rust e o rust-rosetta. Para outros projetos existentes de documentação para contribuir veja rust-learning.

Conheça outros documentaristas de Rust em #rust-docs.