-
Notifications
You must be signed in to change notification settings - Fork 18
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 - Freyja] Update and revamp documentation to focus on non-SC2 organisms #732
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you collapse the parallel ont/illumina segments? they're the same overall steps, but you can just list the tools in separate lines.
maybe also indicate that the freyja_update is only for sc2 or something?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i made a change to the diagram since you're busy. LMK if you approve the changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
⭐ thanks for the updates!!
This PR closes nothing but is long-overdue with all the Freyja updates that have been done in the past!
🗑️ This dev branch should be deleted after merging to main.
🧠 Summary
This PR focuses solely on documentation improvements! No code changes have been made!
Did you know that Freyja now allows for native non-SC2 organisms' support? Neither do our collaborators! This PR is a collaborative effort to make the documentation better and more concise, given the explosion of applicabilities of freyja in the latest releases.
⚡ Impacted Workflows/Tasks
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
⚙️ Algorithm
N/A
➡️ Inputs
N/A
⬅️ Outputs
N/A
🧪 Testing
mkdocs serve
was pleased, and so am I!Suggested Scenarios for Reviewer to Test
Eyeball test of the new documentation! Feedback is much appreciated!
🔬 Final Developer Checklist
workflows_overview
tables to be the tag for the next upcoming release. If you do not know the tag, please put "vX.X.X"🎯 Reviewer Checklist