-
Notifications
You must be signed in to change notification settings - Fork 741
docs: Running pipelines CLI #6525
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Running pipelines CLI #6525
Conversation
christopher-hakkaart
commented
Oct 30, 2025
- Proposal structure for basic usage descriptions
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
|
Thanks Chris, the CLI page is looking much better. It gives a much more comprehensive overview of the available commands. Now I think we just need to whittle down the most important use cases I think part of the reason why the page still felt reference-heavy is because of the exhaustive description of every top-level CLI option. I always found this excessive So I have removed it and moved the important bits to other places. Added a few details to the reference docs, moved the version section after the help section, and moved the config sections to the new config section you added I think the hard/soft config override behavior is probably worth keeping since it's an important distinction, I just copied/pasted but you might want to adjust it to make it fit better in your new section |
Signed-off-by: Christopher Hakkaart <[email protected]>
|
Thanks @bentsherman - this looks great. Dropping the options makes a big difference. I've reshuffled the configuration section and widened the description to include options and commands. Overall, I'm really happy with the structure and framing. I would leave it as is for now and adjust it based on community feedback. I'm also happy to follow your lead if you see anything that you'd like to cut or add if you think it's missing. |
Signed-off-by: Ben Sherman <[email protected]>
|
Okay I'll go ahead and merge Now that the main CLI page is more comprehensive, I wonder if we could move some of the examples from the reference page to the main page That might make the reference page less cluttered and the examples more visible. Though I still see some value in at least having some basic examples on the reference page |