Skip to content
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.

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

docs: updates for v0.1.0 #171

Merged
merged 8 commits into from
Jan 30, 2023
Merged

docs: updates for v0.1.0 #171

merged 8 commits into from
Jan 30, 2023

Conversation

aryarm
Copy link
Member

@aryarm aryarm commented Jan 30, 2023

This PR resolves #169

The main changes are

  1. A new "Motivation" section on the page for the Haplotype file format that motivates the need for a new format and discusses its advantages over the alternatives
  2. A new page titled "Example files" that describes where the example and test files are located as well as how to execute our tests using the example files. We've linked to this page at the bottom of each command's documentation page.
  3. A new "Logging" section on the front page of our documentation that describes how to get log info from haptools

@aryarm aryarm linked an issue Jan 30, 2023 that may be closed by this pull request
9 tasks
@aryarm aryarm requested a review from gymreklab January 30, 2023 19:17
Copy link
Collaborator

@gymreklab gymreklab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for these updates! I think they look great.

@aryarm aryarm merged commit 714142f into main Jan 30, 2023
@aryarm aryarm deleted the docs/reviewers-requested branch January 30, 2023 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: updates ahead of v0.1.0
3 participants