Docs guides

Edit

Goal

Help us grow the nf-core documentation by writing new procedural guides that walk users step-by-step through common tasks, filling gaps in our how-to coverage.

Description

With the documentation v2 release now live, our focus shifts to expanding the collection of procedural guides. Procedural guides are task-focused, step-by-step instructions that help users accomplish a specific goal, from configuring a pipeline for a particular compute environment to troubleshooting a common error.

This project focuses on identifying missing guides and writing clear, well-structured content that follows our documentation style guide:

• Identifying common tasks that lack a procedural guide
• Writing new step-by-step guides for those tasks
• Ensuring guides follow the new style guide and structure
• Adding worked examples, code snippets, and screenshots where helpful
• Reviewing and polishing each other’s guides for clarity and consistency

Our goal is to publish a batch of new procedural guides by the end of the hackathon.

Tasks

This is a great project for anyone who enjoys writing, has run into a tricky task they had to figure out the hard way, or wants to help make nf-core easier to use for everyone.

As an in-person project, we will work together at the table to brainstorm which guides are most needed, divide them up, and review each other’s work as we go.

Specific tasks include:

• Brainstorm and list common tasks that are missing a procedural guide
• Draft new step-by-step guides for identified tasks
• Follow the documentation style guide for structure and tone
• Add worked examples, code snippets, and screenshots
• Review and edit guides written by others in the group
• Validate that examples and commands work as written

For a list of open issues, see the Website issues. More coming soon

If you find other guides you would like to write, please make them into GitHub issues for visibility so we can track progress and avoid duplicating work.

Making PRs

All updates should be made against the main branch of the nf-core/website repository.

Since this is an in-person project, grab Chris at the table for a quick review, or post your PR in #request-review to find a review buddy. Tag Chris on the PR so we can help get it merged before the end of the hackathon.