Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Recurso nacional de biología de redes (NRNB)
- Redactor técnico:
- Rahul Agrawal
- Nombre del proyecto:
- Mejora de la documentación de Cytoscape.Js
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
# Hacer que la documentación de Cytoscape.js sea más accesible para los principiantes.
De acuerdo con la especificación proporcionada por el mentor, he dividido el proyecto en dos categorías y me gustaría implementar estas características en este proyecto. Las ordené en una secuencia de prioridad decreciente.
Funciones clave (principales anteriores)
- Fase 1
Migrar la especificación JSON existente con referencias a archivos de Markdown a los comentarios de JSDoc
Perfeccionar y mejorar la documentación existente, por ejemplo, escribir una mejor descripción o agregar más fragmentos de código de ejemplo
- Fase 2
Escribir instructivos nuevos y hacer videos para abordar temas nuevos o temas básicos de formas más atractivas
- Fase 3
Escribir nuevas demostraciones y hacer videos para dar una idea de cómo son las apps web de Cytoscape completas.
**Objetivos ambiciosos **
Se realizaron algunas mejoras generales en la documentación.