docs: Restructure modules as a section and add registry steps#7030
docs: Restructure modules as a section and add registry steps#7030christopher-hakkaart wants to merge 9 commits intonextflow-io:masterfrom
Conversation
Signed-off-by: Christopher Hakkaart <christopher.hakkaart@gmail.com>
Signed-off-by: Christopher Hakkaart <christopher.hakkaart@gmail.com>
Signed-off-by: Christopher Hakkaart <christopher.hakkaart@gmail.com>
✅ 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 <christopher.hakkaart@gmail.com>
Signed-off-by: Christopher Hakkaart <christopher.hakkaart@gmail.com>
| : Verifies that all required files are present (`main.nf`, `meta.yml`, `README.md`) and that the module spec contains all required fields (name, version, description, license). | ||
|
|
||
| : **Examples:** | ||
| **Examples** |
There was a problem hiding this comment.
I'm divided on whether it's better to show all the module CLI examples together or separately per subcommand. I'm wondering if we should just not show them here at all and incorporate them into the reference docs. Or, maybe your current approach would work better if we just trim down the examples
What do you think?
There was a problem hiding this comment.
I wasn't particularly happy with this either. Examples shown under the subcommands break up the long list, but they also disrupt the page's flow. However, modules were the only command with examples under subcommands, too, so I moved them to the bottom to keep every section on the page the same structure.
It's another discussion, but I've been thinking about a shift to each CLI option having its own page, similar to https://cli.github.com/manual/gh
I like being able to command f things on a page, but this could break up the page, and we could do something interesting with lists or cards, and eventually automations to update.
In the meantime, we can limit the examples to avoid overload.
There was a problem hiding this comment.
I think having a separate page per command would be smart. For now I will just trim the examples
| ```{toctree} | ||
| :hidden: | ||
| :caption: Modules | ||
| :maxdepth: 1 | ||
|
|
||
| modules/modules | ||
| modules/using-modules | ||
| modules/developing-modules | ||
| modules/module-registry | ||
| ``` |
There was a problem hiding this comment.
I think this is the right direction, since modules have effectively become first-class entities like pipelines via nextflow module run
To avoid confusion, I think I will try to remove or significantly trim down the existing Modules page. The Scripts page already has a blurb with links to workflows / processes / modules under "Script definitions", so we could always expand that section if needed. Let me see how it works out
There was a problem hiding this comment.
Sounds good 👍
2 participants
Uh oh!
There was an error while loading. Please reload this page.