Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Recurso Nacional de Biología de Redes (NRNB)
- Escritor técnico:
- Rahul Agrawal
- Nombre del proyecto:
- Mejoramos 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 que me proporcionó 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 descendente.
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
Crear instructivos y crear videos para abordar temas nuevos o abordar temas básicos de formas más atractivas
- Fase 3
Escribir nuevas demostraciones y crear videos para dar una idea de cómo son las aplicaciones web completas de Cytoscape
**Objetivos de estiramiento **
Algunas mejoras generales en la documentación.