Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
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
# Ułatwienie dostępu do dokumentacji Cytoscape.js początkującym.
Zgodnie ze specyfikacją podaną przez mentora podzieliłem projekt na 2 kategorie i chcę wdrożyć w nim te funkcje. Kolejność jest malejąca.
Najważniejsze funkcje (najwyższy priorytet)
- Etap 1
Przeniesienie dotychczasowej specyfikacji JSON z odwołaniami do plików Markdown do komentarzy JSDoc
dopracowanie i ulepszanie istniejącej dokumentacji, np. poprzez napisanie lepszego opisu lub dodanie kolejnych przykładowych fragmentów kodu;
- Etap 2
pisać nowe samouczki i tworzyć filmy, aby omawiać nowe tematy lub przedstawiać podstawowe tematy w bardziej atrakcyjny sposób;
- Faza 3
Tworzenie nowych wersji demonstracyjnych i filmów, aby pokazać, jak działają w pełni funkcjonalne aplikacje internetowe Cytoscape.
**Cel bonusowy **
Wprowadziliśmy też ogólne ulepszenia dokumentacji.