Português (BR) | English (US)
Documentação e Comunidade
Dentro do ecossistema do Querido Diário, este repositório é o responsável pela documentação geral e pelas discussões transversais aos vários repositórios do projeto e sua comunidade.
Conheça mais sobre as tecnologias e a história do projeto no site do Querido Diário
Sumário
Como contribuir
Agradecemos por considerar contribuir com o Querido Diário! :tada:
Você encontra como fazê-lo em nosso Guia de Contribuição!
Além disso, consulte a documentação do Querido Diário para te ajudar.
Como executar
Para gerar a documentação localmente em sua máquina, siga os passos a seguir:
-
Abra um terminal no diretório
docs/do projeto e instale as dependênciaspip install -r requirements.txt -
O projeto está organizado em diretórios por idiomas. Para simular a visualização da documentação, basta acessar o diretório de interesse (
pt_BR/,en/, etc) e executar:make html -
Um diretório chamado
build/será criado dentro do diretório do idioma. Abra o arquivohtml/index.htmlno navegador para visualizar as páginas de documentação a partir da raiz.
Suporte
Ingresse em nosso canal de comunidade para trocas sobre os projetos, dúvidas, pedidos de ajuda com contribuição e conversar sobre inovação cívica em geral.
Agradecimentos
Este projeto é mantido pela Open Knowledge Brasil e possível graças às comunidades técnicas, às Embaixadoras de Inovação Cívica, às pessoas voluntárias e doadoras financeiras, além de universidades parceiras, empresas apoiadoras e financiadoras.
Conheça quem apoia o Querido Diário.
Open Knowledge Brasil
A Open Knowledge Brasil é uma organização da sociedade civil sem fins lucrativos, cuja missão é utilizar e desenvolver ferramentas cívicas, projetos, análises de políticas públicas, jornalismo de dados para promover o conhecimento livre nos diversos campos da sociedade.
Todo o trabalho produzido pela OKBR está disponível livremente.
Licença
Código licenciado sob a Licença MIT.