Esta página contiene los detalles de un proyecto de redacción técnico aceptado para Google 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 la documentación de Cytoscape.Js
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
# Cómo hacer que la documentación de Cytoscape.js sea más accesible para los principiantes.
Según las especificaciones proporcionadas por el mentor, dividí el proyecto en dos categorías y me gustaría implementar estas funciones para este proyecto. Las organizamos en una secuencia de prioridad decreciente.
Funciones clave (principales anteriores)
- Fase 1
Migrar la especificación JSON existente con referencias a los 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
Crear instructivos nuevos y crear videos para abarcar temas nuevos o temas básicos de formas más atractivas.
- Fase 3
Escribe nuevas demostraciones y crea videos para dar una idea de cómo son las aplicaciones web de Cytoscape completas.
**Objetivos de estiramiento **
Algunas mejoras generales en la documentación.