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 snakemake docs #380

Merged
merged 5 commits into from
Jan 24, 2024
Merged

update snakemake docs #380

merged 5 commits into from
Jan 24, 2024

Conversation

rahuldesai1
Copy link
Contributor

  1. Separate Overview from Tutorial page
  2. Make tutorial more interactive and make sure it works
  3. Simplify the lifecycle.md contents. Removed a bunch of unnecessary technical details
  4. Add some more details to the environments/container page


1. Rules that are not part of the task's target are entirely ignored
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed a lot of the technical explanation here because I thought it was too detailed and not that helpful for users.
open to adding it back if ppl think there is value

@@ -134,12 +134,7 @@ def generate_metadata(
fg="yellow",
)

if not metadata_path.exists() and click.confirm(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

removing this because from user tests I've found that it is quite confusing. I think if the file doesn't exist its generally pretty safe to create it without user confirmation since we aren't overwriting anything.

Copy link
Member

@maximsmol maximsmol left a comment

Choose a reason for hiding this comment

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

  1. compress ur images with https://compress-or-die.com/

the jit-task.png can go down to 25.53 kB (-79.19%)
without changing anything

  1. do you have Prettier enabled for markdown? Double-check pls, not sure why we constantly switch the list bullets from * to - and vice versa lol

  2. run major changes through Grammarly (feel free to buy a subscription on the Brex)

docs/source/snakemake/debugging.md Outdated Show resolved Hide resolved
docs/source/snakemake/debugging.md Outdated Show resolved Hide resolved
docs/source/snakemake/overview.md Outdated Show resolved Hide resolved
@rahuldesai1 rahuldesai1 merged commit a523c52 into main Jan 24, 2024
10 checks passed
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