nf-metro docs: bit more detail based on rnaseq example - #4395
Merged
Conversation
✅ Deploy Preview for nf-core-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
ewels
commented
Sep 10, 2026
| Describe the pipeline as a Mermaid graph, with `%%metro` directives to declare the lines. | ||
| NB: `PIPELINE` is a placeholder for your pipeline's name. | ||
|
|
||
| ```txt title="assets/metro_map.mmd" |
Member
Author
There was a problem hiding this comment.
Not for this PR, but I wonder if this is something we want to start including into the nf-core template.. 🤔
Could also have a CI job that regenerates all the images if the file changes. Would mean that the template could then have this path uncommented, and we could include the boilerplate settings for the .mmd and have consistent filenames etc.
Just a thought..
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improved the docs and example
.mmdbased on working with nf-core/rnaseq#1915@netlify /docs/community/brand/workflow-schematics