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

Documentation Update #678

Merged
merged 9 commits into from
Dec 3, 2024
Merged

Documentation Update #678

merged 9 commits into from
Dec 3, 2024

Conversation

frankambrosio3
Copy link
Contributor

@frankambrosio3 frankambrosio3 commented Dec 3, 2024

🗑️ This dev branch should be deleted after merging to main.

🧠 Summary

This PR updates several aspects of the Theiagen documentation.
It updates the TheiaEuk workflow diagram, fixes several broken links, and adds a more thorough explanation of the tools that are deployed upon detection of Candida auris.
It fixes broken links to workflow task files in documentation pages for TheiaEuk, TheiaProk, TheiaMeta, Augur, Snippy_Tree and NCBI_Scrub.
It adds more thorough explanations of the components of Snippy_Streamline, Snippy_Streamline_FASTA, Snippy_Tree and Snippy_Variants.
It also reformats and adds to the contribution guide.

⚡ Impacted Workflows/Tasks

This PR only modifies documentation. No changes are made to functional code.

This PR may lead to different results in pre-existing outputs: No

This PR uses an element that could cause duplicate runs to have different results: No

🛠️ Changes

It updates the TheiaEuk workflow diagram, fixes several broken links, and adds a more thorough explanation of the tools that are deployed upon detection of Candida auris.
It fixes broken links to workflow task files in documentation pages for TheiaEuk, TheiaProk, TheiaMeta, Augur, Snippy_Tree and NCBI_Scrub.
It adds more thorough explanations of the components of Snippy_Streamline, Snippy_Streamline_FASTA, Snippy_Tree and Snippy_Variants.
It also reformats and adds to the contribution guide.

⚙️ Algorithm

This PR only modifies documentation. No changes are made to functional code.

➡️ Inputs

This PR only modifies documentation. No changes are made to functional code.

⬅️ Outputs

This PR only modifies documentation. No changes are made to functional code.

🧪 Testing

I clicked all the links in the docs pages to make sure they are not dead links, and I reviewed the docs from the perspective of a new user.

Suggested Scenarios for Reviewer to Test

This PR only modifies documentation. No changes are made to functional code.

🔬 Final Developer Checklist

  • The workflow/task has been tested and results, including file contents, are as anticipated
  • [NA] The CI/CD has been adjusted and tests are passing (Theiagen developers)
  • [NA] Code changes follow the style guide
  • Documentation and/or workflow diagrams have been updated if applicable (Theiagen developers only)

🎯 Reviewer Checklist

  • [NA] All changed results have been confirmed
  • You have tested the PR appropriately (see the testing guide for more information)
  • [NA] All code adheres to the style guide
  • MD5 sums have been updated
  • The PR author has addressed all comments
  • The documentation has been updated

@frankambrosio3 frankambrosio3 requested a review from a team as a code owner December 3, 2024 14:46
Copy link
Member

@sage-wright sage-wright left a comment

Choose a reason for hiding this comment

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

🌟

@sage-wright sage-wright merged commit 12404d8 into main Dec 3, 2024
3 checks passed
@sage-wright sage-wright deleted the fja-theiaeuk-docs branch December 3, 2024 15:54
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.

2 participants