Add preview feature warnings to documentation#6663
Merged
bentsherman merged 3 commits intomasterfrom Dec 17, 2025
Merged
Conversation
Add warning admonitions to documentation pages for preview features (typed processes and workflow recursion) to clarify that the syntax and behavior may change in future releases. Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
bentsherman
reviewed
Dec 16, 2025
bentsherman
reviewed
Dec 16, 2025
bentsherman
reviewed
Dec 16, 2025
Collaborator
|
I'd prefer to limit sequential admonitions if possible. I've merged the two into a single note to address the preview feature requirements, and that they may change. We saw regular questions/errors being reported in Slack, so I think the more explicit we can be to advise developers the better. |
Member
Author
|
My primary concern is to be as much as possible explicit to provide more context for LLMs, and therefore better to be verbose and redundant than terse in order to reduce the risk to hallucinate the model |
bentsherman
approved these changes
Dec 17, 2025
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
3 participants
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.
Summary
Files changed
docs/process-typed.md- Added warning + note admonitionsdocs/workflow.md- Added warning + note for recursion sectiondocs/reference/process.md- Added warning + note for typed inputs/outputs sectiondocs/reference/feature-flags.md- Made preview warnings consistentTest plan
🤖 Generated with Claude Code