ga4gh / ga4gh/vrs-python

Add hosted docs

Open
#548 2 comments 0 reactions 0 assignees View on GitHub
documentation priority:high
Dominant language
Python
Stars
62
Forks
42
Avg merge
1h 2m
Merged PRs (30d)
1

Description

### Feature description

Add hosted HTML docs (on RTD) for technical and general-audience documentation

### Use case

Documentation will help both users and developers understand VRS-Python better

### Acceptance Criteria

Given I'm a non-technical user,
When I go to vrs-python.readthedocs.io (or something similar),
Then I should see documentation on general info about VRS-Python (I like Beacon's general docs as an example: https://genomebeacons.org/)

Given I'm a developer,
When I go to vrs-python.readthedocs.io (or something similar),
Then I should see technical documentation about VRS-Python (I like Beacon's general docs as an example: https://docs.genomebeacons.org/)

### Proposed solution

_No response_

### Alternatives considered

_No response_

### Implementation details

_No response_

### Potential Impact

_No response_

### Additional context

More good examples that @jsstevenson created for some of our projects:
* https://coolseqtool.readthedocs.io/0.13.0/
* https://gene-normalizer.readthedocs.io/latest/
* https://disease-normalizer.readthedocs.io/latest/
* https://fusor.readthedocs.io/0.5.0/

### Contribution

None

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.