Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- National Resource for Network Biology (NRNB) (en anglais)
- Rédacteur technique:
- Rahul Agrawal
- Nom du projet:
- Amélioration de la documentation Cytoscape.js
- Durée du projet:
- Durée standard (trois mois)
Project description
# Rendre la documentation Cytoscape.js plus accessible aux débutants.
Conformément aux spécifications données par le mentor, j'ai divisé le projet en deux catégories et j'aimerais implémenter ces fonctionnalités pour ce projet. Je les ai classées par ordre de priorité décroissante.
Principales caractéristiques (priorité élevée)
- Phase 1
Migrer la spécification JSON existante avec des références à des fichiers Markdown vers 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édiger de nouveaux tutoriels et réaliser des vidéos pour aborder de nouveaux sujets ou aborder des sujets basiques de manière plus convaincante
- Phase 3
Écrire de nouvelles démonstrations et créer des vidéos pour donner un aperçu des applications Web Cytoscape complètes.
**Objectifs supplémentaires **
Améliorations générales apportées à la documentation.