Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- National Resource for Network Biology (NRNB)
- Penulis teknis:
- Rahul Agrawal
- Nama project:
- Meningkatkan Kualitas Dokumentasi Cytoscape.Js
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
# Membuat dokumentasi Cytoscape.js lebih mudah diakses oleh pemula.
Sesuai dengan spesifikasi yang diberikan oleh mentor, saya telah membagi project menjadi dua kategori dan saya ingin menerapkan fitur ini untuk project ini. Saya telah mengatur urutan prioritas yang menurun.
Fitur Utama (Prioritas Utama)
- Fase 1
Memigrasikan spesifikasi JSON yang ada dengan referensi ke file Markdown ke komentar JSDoc
Menyempurnakan dan meningkatkan dokumentasi yang ada seperti menulis deskripsi yang lebih baik atau menambahkan lebih banyak contoh cuplikan kode
- Fase 2
Menulis tutorial baru &membuat video untuk membahas topik baru atau membahas topik dasar dengan cara yang lebih menarik.
- Tahap 3
Menulis demo baru &membuat video untuk memberikan gambaran tentang seperti apa aplikasi web Cytoscape yang lengkap.
**Sasaran Tambahan **
Beberapa peningkatan umum pada dokumentasi.