Documentação

A documentação técnica do projeto serve para auxiliar a compreensão de pessoas interessadas, usuárias e desenvolvedoras, registrando informações fundamentais e mais profundamente descritas sobre como o Querido Diário funciona e quais recursos oferece.

Toda a documentação oficial (este site!) é gerada a partir dos arquivos .rst do repositório, construida com o gerador de documentação Sphinx, usando o tema sphinx-rtd-theme e fica hospedada no serviço Read The Docs.

Cada uma das páginas deste site, listadas no menu de navegação, corresponde a um arquivo de mesmo nome no diretório /docs. Também é possível chegar aos arquivos por meio do “Editar no GitHub” presente no topo de todas as páginas.

Importante

É importante que a documentação esteja atualizada e seja relevante para a comunidade. Não hesite em contribuir com pull requests (PRs) para ajustes, complementos e adições, além de traduções para outros idiomas.