Progetto NRNB (National Resource for Network Biology)

Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.

Riepilogo del progetto

Organizzazione open source:
National Resource for Network Biology (NRNB)
Redattore tecnico:
Rahul Agrawal
Nome del progetto:
Miglioramento della documentazione di Cytoscape.Js
Durata del progetto:
Durata standard (3 mesi)

Project description

# Rendere la documentazione di Cytoscape.js più accessibile ai principianti.

Secondo le specifiche fornite dal mentore, ho suddiviso il progetto in due categorie e mi piacerebbe implementare queste funzionalità per questo progetto. Le ho disposte in una sequenza di priorità decrescente.

  • Funzionalità principali (priorità massima)

    - Fase 1

  • Migrazione della specifica JSON esistente con riferimenti ai file Markdown ai commenti JSDoc

  • Raffinare e migliorare la documentazione esistente, ad esempio scrivendo una descrizione migliore o aggiungendo altri snippet di codice di esempio

    - Fase 2

  • Scrivere nuovi tutorial e realizzare video per trattare nuovi argomenti o per trattare argomenti di base in modi più accattivanti.

    - Fase 3

  • Scrivere nuove demo e realizzare video per dare un'idea di come sono le app web Cytoscape complete.

  • **Obiettivi di allungamento **

  • Alcuni miglioramenti generali alla documentazione.