Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- National Resource for Network Biology (NRNB)
- Pisarz techniczny:
- Rahul Agrawal
- Nazwa projektu:
- Ulepszanie dokumentacji Cytoscape.Js
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
# Łatwiejszy dostęp do dokumentacji Cytoscape.js dla początkujących.
Zgodnie ze specyfikacją przedstawioną przez mentora podzieliliśmy projekt na 2 kategorie i zamierzam wdrożyć opisane funkcje w tym projekcie. Ułożyłem je w sekwencji o malejącym priorytecie.
Najważniejsze funkcje (najlepsze wcześniej)
- Faza 1
przeniesienie istniejącej specyfikacji JSON z odwołaniami do plików Markdown do komentarzy JSDoc.
Ulepszenie i ulepszenie istniejącej dokumentacji, np. napisanie lepszego opisu lub dodanie większej liczby przykładowych fragmentów kodu
- Etap 2
Tworzenie nowych samouczków i filmów poruszających nowe tematy lub omawiające podstawowe tematy w bardziej atrakcyjny sposób.
- Faza 3
Pisanie nowych wersji demonstracyjnych i nagrywanie filmów, które mają pokazać, jak działają w pełni funkcjonalne aplikacje internetowe Cytoscape.
**Cele rozciągania **
Ogólne ulepszenia w dokumentacji.