Skip to content

docs: Move channel factories and operators to stdlib reference - #7414

Merged
bentsherman merged 4 commits into
masterfrom
docs-stdlib-channel
Aug 6, 2026
Merged

docs: Move channel factories and operators to stdlib reference#7414
bentsherman merged 4 commits into
masterfrom
docs-stdlib-channel

Conversation

@bentsherman

Copy link
Copy Markdown
Member

This PR builds on #7409 by consolidating the channel factories and typed operators pages into the stdlib reference:

  • Channel factories -> channel namespace
  • Typed operators -> Channel type

Also adds a tutorial for topic channels, since the channel.topic() reference was trying to give a mini-tutorial. I based it loosely on nf-core/rnaseq since rnaseq-nf doesn't collect tool versions and nf-core/rnaseq is the most well-known pipeline that uses this pattern

@bentsherman
bentsherman requested review from a team as code owners July 30, 2026 19:44
@netlify

netlify Bot commented Jul 30, 2026

Copy link
Copy Markdown

Deploy Preview for nextflow-docs ready!

Name Link
🔨 Latest commit eba6936
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs/deploys/6a74016c8882bb0008f595c7
😎 Deploy Preview https://deploy-preview-7414--nextflow-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@bentsherman

Copy link
Copy Markdown
Member Author

If the tutorial feels weird, another option would be to add a section on topic channels to the "Workflows" page under "Dataflow". It would be much shorter and introductory, similar to the current channel.topic() docs. I figured it deserved an end-to-end example, hence the tutorial

@bentsherman
bentsherman force-pushed the docs-stdlib-channel branch from ce6243f to 08cd813 Compare August 4, 2026 13:04
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman
bentsherman force-pushed the docs-stdlib-channel branch from e09fd8f to 4557708 Compare August 5, 2026 23:26

@christopher-hakkaart christopher-hakkaart left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good already. I made very minor suggestions in #7451

Signed-off-by: Christopher Hakkaart <christopher.hakkaart@gmail.com>
@bentsherman
bentsherman merged commit 5fbcc8d into master Aug 6, 2026
24 checks passed
@bentsherman
bentsherman deleted the docs-stdlib-channel branch August 6, 2026 03:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants