James Fellows Yates
01/15/2026, 7:51 AMmashehu
01/15/2026, 8:31 AMJames Fellows Yates
01/15/2026, 10:48 AMMatthias Zepper
01/15/2026, 11:47 AMnf_core/pipelines/create/template_features.yml and adding the docs/CONTRIBUTING.md there?
documentation:
skippable_paths:
- "docs"
short_description: "Add documentation"
description: "Add documentation to the pipeline"
help_text: |
This will add documentation markdown files where you can describe your pipeline.
It includes:
- docs/CONTRIBUTING.md: A contributing guide to help others contribute to your pipeline.
- docs/README.md: A README file where you can describe the structure of your documentation.
- docs/output.md: A file where you can explain the output generated by the pipeline
- docs/usage.md: A file where you can explain the usage of the pipeline and its parameters.
These files come with an exemplary documentation structure written.
linting:
files_exist:
- "docs/CONTRIBUTING.md"
- "docs/output.md"
- "docs/README.md"
- "docs/usage.md"
nfcore_pipelines: False
custom_pipelines: True
default: trueMatthias Zepper
01/15/2026, 11:51 AMJames Fellows Yates
01/15/2026, 12:20 PMMatthias Zepper
01/15/2026, 12:31 PMJames Fellows Yates
01/15/2026, 12:38 PMJames Fellows Yates
01/15/2026, 12:39 PMJames Fellows Yates
01/15/2026, 12:39 PMJames Fellows Yates
01/15/2026, 12:40 PMmashehu
01/15/2026, 7:33 PMnf-core TODO and that is removed in this check (to avoid linting errors because of that), but is still in the template. Don't remember at the moment, why this isn't a problem in other files (hopefully tomorrow-morning–me remembers (or @Júlia Mir))James Fellows Yates
01/15/2026, 7:38 PMJames Fellows Yates
01/15/2026, 7:39 PMJúlia Mir
01/19/2026, 11:25 AMJúlia Mir
01/19/2026, 11:25 AMJames Fellows Yates
01/19/2026, 11:26 AMmashehu
01/19/2026, 11:44 AMJúlia Mir
01/19/2026, 11:46 AMJames Fellows Yates
01/19/2026, 11:51 AMJúlia Mir
01/19/2026, 11:51 AMJames Fellows Yates
01/19/2026, 11:54 AMmashehu
01/19/2026, 11:54 AMJames Fellows Yates
01/19/2026, 12:06 PMJames Fellows Yates
01/19/2026, 12:07 PMmashehu
01/19/2026, 12:11 PMJames Fellows Yates
01/19/2026, 12:13 PMJúlia Mir
01/19/2026, 1:48 PMJames Fellows Yates
01/19/2026, 1:49 PMJames Fellows Yates
01/19/2026, 1:49 PM