This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- National Resource for Network Biology (NRNB)
- Technical writer:
- Rahul Agrawal
- Project name:
- Improving Cytoscape.Js Documentation
- Project length:
- Standard length (3 months)
Project description
# Making the Cytoscape.js documentation more accessible to novices.
As per the specification given by the mentor, I have divided the project into two categories and I will like to implement these features for this project. I have arranged in a sequence of decreasing priority.
Key Features (Top Prior)
- Phase 1
Migrating the existing JSON specification with references to Markdown files to the JSDoc comments
Refining and improving the existing documentation like writing a better description or adding more example code snippets
- Phase 2
Writing new tutorials & making videos to cover new topics or to cover basic topics in more compelling ways.
- Phase 3
Writing new demos & making videos to give a sense of what fully-fledged Cytoscape web apps are like.
**Stretch-Goals **
Some general improvements to the documentation.