Skip to content

docs: tracking issue for documentation improvements at the Snakemake Hackathon 2026 #4011

@dlaehnemann

Description

@dlaehnemann

If you want to pick up one of the issues below, just tick its box, and link to the issue or pull request you create for it. Either by editing the issue number in here, or by commenting below.

Also, please feel free to add further stuff in the comments.

things that are unclear in the docs

  • profiles documentation should maybe have its own page for discoverability, and should be clearer (for example, different levels of profiles are unclear workflow vs. user vs. system-wide)
  • Snakefile and Rules should be Writing Workflows and the grammar that is under Writing Workflows should be moved to the API or somewhere else
  • installation issues:
    • how-to install snakemake with pixi
    • on Contribution page, have a proper linkout to how to set up your pixi environment with your specific IDE`
    • when installing with pip, the --only-dep flag is not working (snakemake itself is also installed, anyways)
  • make it clearer in the logs, that log: "some/file.txt" does not contain anything unless you redirect some output there docs: Minor docs improvements #4089
  • next buttons in the tutorial, as you currently have to navigate through the tutorial via the main menu
  • make the snakemake workflow catalog filterable by keyword
  • mention workflow hub as a workflow discoverability tool

things that would be nice to have in the docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions