Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of Dokumen.
Ringkasan proyek
- Organisasi open source:
- National Resource for Network Biology (NRNB)
- Penulis teknis:
- Rahul Agrawal
- Nama proyek:
- Memperbaiki Dokumentasi Cytoscape.Js
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
# Membuat dokumentasi Cytoscape.js lebih mudah diakses oleh pemula.
Sesuai spesifikasi yang diberikan oleh mentor, saya telah membagi proyek menjadi dua kategori dan saya ingin mengimplementasikan fitur-fitur ini untuk proyek ini. Saya telah mengatur urutan prioritas menurun.
Fitur Utama (Teratas)
- Tahap 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
- Tahap 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 aplikasi web Cytoscape yang lengkap.
**Tujuan Peregangan **
Beberapa peningkatan umum untuk dokumentasi.