Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗑️ 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
🎯 Reviewer Checklist