search

basedosdados / backend

Backend da BD
https://backend.basedosdados.org/graphql
GNU General Public License v3.0
8 stars 1 forks source link

Melhorar a documentação do backend (django) da bd. #616

Open jhonylucas74 opened 1 month ago

jhonylucas74 commented 1 month ago

Atualmente, a documentação é muito rasa e aborda apenas superficialmente alguns tópicos. Para a saúde do projeto, seria interessante criar uma documentação mais detalhada, que ajudasse novos desenvolvedores e organizasse o projeto, além de permitir a identificação de pontos de melhoria que podemos implementar no futuro.

jhonylucas74 commented 1 month ago

Snapshot de como a documentação está nesse momento. Após minhas alterações irei comentar aqui como ficou após eu criar algumas outras páginas na doc.

https://github.com/basedosdados/backend/assets/5381250/b3415801-016f-471c-abe3-40a5aef58622

jhonylucas74 commented 1 month ago

Finalizei a documentação relacionada ao GraphQl. Ela pode ser encontrada aqui: https://github.com/basedosdados/backend/wiki/GraphQL

Próximo passo é a criação dos diagramas do banco de dados.

jhonylucas74 commented 1 month ago

Documentação da estrutura dos modelos está pronta. https://github.com/basedosdados/backend/wiki/Estrutura-dos-Dados