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 - Freyja] Update and revamp documentation to focus on non-SC2 organisms #732

Merged
merged 17 commits into from
Jan 27, 2025

Conversation

cimendes
Copy link
Member

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

  • Only Freyja's documentation has been changed. No code changes whatsoever!

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

  • Only Freyja's documentation has been changed. No code changes whatsoever!

⚙️ 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

  • The workflow/task has been tested and results, including file contents, are as anticipated
  • The CI/CD has been adjusted and tests are passing (Theiagen developers)
  • Code changes follow the style guide
  • Documentation and/or workflow diagrams have been updated if applicable
    • You have updated the "Last Known Changes" field for any affected workflows in the respective workflow documentation page and for every entry in the three 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

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

@cimendes cimendes requested a review from a team as a code owner January 21, 2025 12:11
Copy link
Member

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?

Copy link
Member

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

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.

⭐ thanks for the updates!!

@sage-wright sage-wright merged commit 4f9bb14 into main Jan 27, 2025
3 checks passed
@sage-wright sage-wright deleted the fja-freyja-docs branch January 27, 2025 14:26
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.

3 participants