nextflow-io / nextflow-io/training

Plugin dev: coordinate with Nextflow docs to avoid content overlap

Open
#925 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

side quests
Dominant language
Nextflow
Stars
271
Forks
329
Avg merge
1d 1h
Merged PRs (30d)
11

Description

From PR #761 review by @FriederikeHanssen:

Looking at the plugin page we got very similar links to how to use and how to develop. I haven't worked my way through the nextflow docs there, but we should probably consolidate this to keep things from diverging/duplicating efforts.

The training material and the official Nextflow plugin documentation (https://nextflow.io/docs/latest/plugins/developing-plugins.html) cover similar ground. Worth coordinating to ensure they complement rather than duplicate each other.

🤖 Generated with Claude Code

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR #761 and the training material about plugins, then compare it with the official Nextflow plugin documentation at https://nextflow.io/docs/latest/plugins/developing-plugins.html. Done means the two sources have complementary scope rather than duplicated or diverging content, with the needed documentation changes identified.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.