Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- National Resource for Network Biology (NRNB)
- Rédacteur technique:
- Rahul Agrawal
- Nom du projet:
- Améliorer la documentation de Cytoscape.Js
- Durée du projet:
- Durée standard (3 mois)
Project description
# Rendre la documentation Cytoscape.js plus accessible aux débutants
Conformément aux spécifications fournies par le mentor, j'ai divisé le projet en deux catégories et j'aimerais mettre en œuvre ces fonctionnalités pour ce projet. J'ai organisé une liste de priorités décroissantes.
Principales fonctionnalités (les plus anciennes)
- Phase 1
Migrer la spécification JSON existante avec des références aux fichiers Markdown dans les commentaires JSDoc
Affiner et améliorer la documentation existante, par exemple en rédigeant une meilleure description ou en ajoutant d'autres exemples d'extraits de code
- Phase 2
Rédaction de nouveaux tutoriels et vidéos pour aborder de nouveaux sujets ou aborder des sujets basiques de façon plus attrayante.
- Phase 3
Créer des démonstrations et réaliser des vidéos pour vous donner une idée de la version complète des applications Web Cytoscape.
**Objectifs ambitieux **
Quelques améliorations générales apportées à la documentation