Improve VRS and vrs-python documentation

[reece]

Submitter Name

Reece Hart

Submitter Affiliation

MyOme

Submitter Github Handle

reece

Additional Submitter Details

No response

Which event day would the project be offered?

• [X] ISMB 2022 Hackathon Day 1
• [ ] ISMB 2022 Hackathon Day 2

Project Details

The goal of this project is to improve the experience of those who are new to VRS. At the start of the session, we will identify areas of focus based in part on the experience and skills of the participants. Possible activities include:

• Reading https://vrs.ga4gh.org/ and collecting feedback.
• Learning how update VRS documentation and implementing identified changes.
• Creating short, focused video tutorials for new users.

Required Skills

Desirable skills: Python, sphinx, jupyter notebooks, video editing, proofreading, Read the Docs

[larrybabb]

@ahwagner and @larrybabb assessed this. This proposal is designed for those folks that are new to VRS that would like to work with a VRS co-lead to improve the documentation, collect feedback and identify tasks that need to be done to improve the documentation all around. The reach goal would be to push one or more updates to the documentation for the next version of the spec.