New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Init the read the docs #47

Merged

julesjacobsen merged 1 commit into main from add_docs

Jan 28, 2021

Collaborator

ielis commented Jan 28, 2021

Hi @julesjacobsen
I am adding some initial documentation to this PR. For start, I'd like to have several pages of the docs:

Get started page with some 7-liners, e.g. how to parse BED record, how to parse VCF line into Variant using VcfConverter, etc.
motivation behind the library, overall design and things that are currently in README.md
explanations of the individual concepts (GenomicAssembly, Contig, ... Variant)

Does it looks good to you?

Addresses #44


          Init the read the docs

4456a96

ielis added the documentation label

ielis requested a review from julesjacobsen

January 28, 2021 16:12

julesjacobsen merged commit 6b9dfd3 into main

Contributor

julesjacobsen commented Jan 28, 2021

Great, thanks @ielis!

julesjacobsen deleted the add_docs branch

January 28, 2021 21:20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels