Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- National Resource for Network Biology (NRNB)
- Pisarz techniczny:
- Rahul Agrawal
- Nazwa projektu:
- Udoskonalanie 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ą podaną przez mentora podzieliliśmy projekt na 2 kategorie i chcę wdrożyć te funkcje w tym projekcie. Ustaliliśmy kolejność malejących priorytetów.
Najważniejsze funkcje (najważniejsze wcześniej)
- Etap 1
migracja istniejącej specyfikacji JSON z odwołaniami do plików Markdown do komentarzy JSDoc;
Udoskonalenie i udoskonalenie istniejącej dokumentacji, np. napisanie lepszego opisu lub dodanie większej liczby przykładowych fragmentów kodu
- Etap 2
Pisanie nowych samouczków i filmów poruszających nowe tematy lub prezentujących w bardziej atrakcyjny sposób podstawowe zagadnienia.
- Etap 3
Tworzenie nowych prezentacji i filmów, które pokazują, jak działają w pełni funkcjonalne aplikacje internetowe Cytoscape.
**Cele rozciągające **
Ogólne ulepszenia dokumentacji.