National Resource for Network Biology (NRNB) project
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["This project aims to improve the Cytoscape.js documentation, making it more accessible to new users."],["The project will focus on migrating JSON specifications to JSDoc comments, refining existing documentation, and creating new tutorials and videos."],["Stretch goals include general improvements to the documentation and potentially developing new demos and videos showcasing Cytoscape web apps."],["This is a Google Season of Docs project, undertaken by Rahul Agrawal for the National Resource for Network Biology (NRNB), spanning three months."]]],["The technical writing project aims to enhance Cytoscape.js documentation accessibility for beginners. Key actions include migrating JSON specifications to JSDoc comments, improving existing documentation with descriptions and code examples, and creating new tutorials and videos. The project also involves developing new demos and videos to showcase Cytoscape web apps. Secondary goals include general documentation enhancements, and the project has a standard length of three months. It will be implemented in three phases.\n"]]
