nf-core / nf-core/tools

Documentation shows the old commands without `pipelines` prefix

Open
#3,287 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation good-first-issue
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of the bug

This issue is on the nf-core/website repo but related to nf-core/tools documentation. Some of the commands from the documentation still show the old structure without the pipelines prefix.
For example: https://nf-co.re/docs/nf-core-tools/pipelines/schema#build-a-pipeline-schema

Command used and terminal output

System information

No response

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 with the linked nf-core/tools documentation page and review its command examples for the missing pipelines prefix. Compare each command with the current structure, then update the outdated documentation and verify that the examples consistently use the current commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.