docs: update + reorganize readme #376
Conversation
korikuzma
added
documentation
Co-authored-by: James Stevenson <james.sharpsteen@gmail.com>
|
|
||
| - **ga4gh.core package** Python language support for certain nascent standards | ||
| in GA4GH. Eventually, this package should be moved to a distinct repo. | ||
| ## Features |
There was a problem hiding this comment.
@korikuzma I think the Features section should not be broken down by module. But instead it should be a bullet list of separate features (see hgvs read.me). I think it is harder to discern the specific features as it feels more technical to go through modules right out of the gate.
There was a problem hiding this comment.
@larrybabb should we be distinguishing between VRS Python features (ie the translator and annotator) and VRS features (a nonambiguous description of variation)? Or maybe bullet point one is like "Pydantic implementation of VRS models, which enables <...>" and then the next bullet points are the additional tools provided in the package?
There was a problem hiding this comment.
Updated in last commit. Should I include dataproxy or nah?
korikuzma
requested review from
larrybabb,
jsstevenson,
theferrit32 and
toneillbroad
close #368
Ideally, in the future we will create a rtd so that our readme isn't so long