Skip to content

Conversation

@christopher-hakkaart
Copy link
Collaborator

  • Proposal structure for basic usage descriptions

Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
@netlify
Copy link

netlify bot commented Oct 30, 2025

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit c252b95
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/690caf3409ab01000886ac6e
😎 Deploy Preview https://deploy-preview-6525--nextflow-docs-staging.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.

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]>
@christopher-hakkaart christopher-hakkaart marked this pull request as ready for review November 5, 2025 20:57
@christopher-hakkaart christopher-hakkaart requested a review from a team as a code owner November 5, 2025 20:57
@bentsherman bentsherman self-requested a review November 5, 2025 22:23
@bentsherman
Copy link
Member

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]>
@christopher-hakkaart
Copy link
Collaborator Author

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.

@bentsherman
Copy link
Member

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

@bentsherman bentsherman merged commit 6d2a34f into nextflow-io:master Nov 6, 2025
25 checks passed
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