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élioration de 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é cette liste par ordre de priorité décroissante.
Principales fonctionnalités (précédentes)
- Phase 1
Migrer la spécification JSON existante avec des références aux fichiers Markdown vers les commentaires JSDoc
Affiner et améliorer la documentation existante, comme la rédaction d'une meilleure description ou l'ajout de plus d'exemples d'extraits de code
- Phase 2
Rédiger de nouveaux tutoriels et réaliser des vidéos sur de nouveaux sujets ou sur des sujets simples de manière plus captivante
- Phase 3
Rédiger de nouvelles démos et réaliser des vidéos pour donner un aperçu de la version complète des applications Web Cytoscape.
**Objectifs ambitieux **
Voici quelques améliorations générales apportées à la documentation.