You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Home <- landing page
Tutorial <- landing page
Demo workflow
Hands on tutorial
How-to guides <- landing page
How to use `template-nf`
How to customise the template
How to develop Nextflow on remote servers (VSCode)
Reference <- landing page
Template components <- landing page
`main.nf`
`nextflow.config`
`modules/`
`bin/`
`config/`
Extra bits
Resources
Explanation <- landing page
Why `template-nf`(?)
Best practices
Samplesheets
Containers per process
...
Resource configuration
Home page
Main landing page that people will see first. Mainly tidy the links that are included here, and add a Getting started section that points to the Demo Workflow.
Contents:
Welcome/intro
Who is the DSL2 template for?
Getting started (i.e. demo workflow)
Site contents, similar to Navigation
Attention newcomers callout
Acknowledgements
Explanation section
Catch-all for best practices, the "why you should do X instead of Y", and FAQs that are largely missing from existing resources and docs.
This will look something like taking out the "why" out of Tutorials/How-to guides/Reference pages to have a central collection of best practices.
Each page should be modular (i.e. explains one thing, and one thing well) so it can be linked to in external training material and docs.
The text was updated successfully, but these errors were encountered:
Suggestions on:
template-nf
documentationBased on the guidelines of https://diataxis.fr/.
Suggested reading/content order:
template-nf
template-nf
for own workflowsNavigation
Suggested navbar and renaming pages based on: https://diataxis.fr/complex-hierarchies/
Home page
Main landing page that people will see first. Mainly tidy the links that are included here, and add a Getting started section that points to the Demo Workflow.
Contents:
Explanation section
Catch-all for best practices, the "why you should do X instead of Y", and FAQs that are largely missing from existing resources and docs.
This will look something like taking out the "why" out of Tutorials/How-to guides/Reference pages to have a central collection of best practices.
Each page should be modular (i.e. explains one thing, and one thing well) so it can be linked to in external training material and docs.
The text was updated successfully, but these errors were encountered: