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

📝 update docs #47

Merged
merged 4 commits into from
Sep 17, 2024
Merged

📝 update docs #47

merged 4 commits into from
Sep 17, 2024

Conversation

migbro
Copy link
Collaborator

@migbro migbro commented Sep 17, 2024

Description

After recent requests for clarification from the community, documentation has been updated to address the following general facets of the workflow:

  • It is a small cohort calling workflow, not a study-wide one, intended for trios mostly
  • It also follows best practices for WGS. WXS will follow in a later update
  • Documentation does not address workflow outputs. This fixes that

Fixes # https://d3b.atlassian.net/browse/BIXU-3749

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Environment:
  • Test files:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have committed any related changes to the PR

@migbro migbro added documentation Adds documentation bix-dev This issue or pull request is bix-dev work labels Sep 17, 2024
@migbro migbro self-assigned this Sep 17, 2024
README.md Outdated Show resolved Hide resolved
Co-authored-by: Dan Miller <dmiller15@users.noreply.github.com>
@migbro migbro merged commit b223712 into master Sep 17, 2024
1 check passed
@migbro migbro deleted the feature/mb-update-docs branch September 17, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bix-dev This issue or pull request is bix-dev work documentation Adds documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants