Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- National Resource for Network Biology (NRNB)
- Redator técnico:
- Rahul Agrawal
- Nome do projeto:
- Como melhorar a documentação do Cytoscape.js
- Duração do projeto:
- Duração padrão (três meses)
Project description
# Tornar a documentação do Cytoscape.js mais acessível para iniciantes.
De acordo com a especificação fornecida pelo mentor, dividi o projeto em duas categorias e gostaria de implementar esses recursos. Eu organizei em uma sequência de prioridade decrescente.
Principais recursos (prioridade máxima)
- Fase 1
Migrar a especificação JSON atual com referências a arquivos Markdown para os comentários do JSDoc
Aprimorar e melhorar a documentação existente, como escrever uma descrição melhor ou adicionar mais exemplos de snippets de código
- Fase 2
Escrever novos tutoriais e fazer vídeos sobre temas novos ou básicos de maneiras mais interessantes.
- Fase 3
Criação de novas demonstrações e vídeos para dar uma ideia de como são os apps da Web do Cytoscape.
**Metas de alongamento **
Algumas melhorias gerais na documentação.