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 GatherSampleEvidence & TrainGCNV docs #681

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

VJalili
Copy link
Member

@VJalili VJalili commented May 29, 2024

This PR extends the documentation of the GatherSampleEvidence and TrainGCNV workflows. Specifically, it implements the following changes.

  • Extends the documentation on the inputs and outputs of the GatherSampleEvidence, GatherBatchEvidence, and TrainGCNV workflows.
  • Instead of enlisting inputs and outputs, they are formatted as sections. This enables referencing them individually, which is useful when referencing an output of workflow passed as input to another workflow. The header level is set to 4 (i.e., ####); hence, these sections are not rendered in the quick navigation section (top-right panel) to reduce clutter.
  • Adds diagrams for better visualization of up and downstream dependencies of workflows, currently implemented for GatherSampleEvidence, GatherBatchEvidence, EvidenceQC, and TrainGCNV workflows.
  • Add JS & CSS components to enable highlighting text, which is used in this PR to tag optional outputs.

@VJalili VJalili added the documentation Improvements or additions to documentation label May 29, 2024
@VJalili VJalili marked this pull request as ready for review August 2, 2024 17:18
@VJalili VJalili requested a review from mwalker174 August 2, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant