Bundled documentation
All documentation must be bundled with the pipeline code in the main repository, within a directory called docs
.
Documentation must only be hosted on the nf-core website and GitHub. Hosting the documentation at a second location (such as custom readthedocs website, or GitHub pages etc) is not allowed. This is to ensure that users of nf-core pipelines can always intuitively find the documentation for all nf-core pipelines in the same way.
Documentation must include at least the following files:
README.md
docs/usage.md
docs/output.md
Additional pages (e.g. tutorials, FAQs) can be added and will be automatically rendered on the nf-core website pipeline page.
- Contributing
- Pipelines
- Software packaging
- nf-test
- Website
- Code editors and styling
- Github
- How to contribute to nf-core
- Project proposals
-
- Tutorials
- Use nf-core pipelines
- Adding a pipeline
- Tests and test data
- Pipelines
- Contributing to nf-core
- External usage
- Google colab
- Nextflow training
- nf-core training
- Contributing training
- Overview
-
-
- Guidelines
- Graphic design
- Pipelines
- Components
- Documentation
- External use
- Google slides progressbar
- Pull request review
-
- Checklists
- Pipeline release
- Community governance
- nf-core/tools
- Installation
- Test datasets
- TUI
- Custom remotes
- API Reference