-
Notifications
You must be signed in to change notification settings - Fork 687
Split standard library docs into multiple pages #5993
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
Conversation
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Love the direction. I'll do some research and thinking and try to come up with some options as well. |
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
…nextflow into docs-standard-types
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
A few thoughts:
I got a bit excited and pushed my proposal to your branch. I've reverted, but you'll be able to see what I was proposing in the commits. |
…classes Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
I introduced the concept of "namespaces" as a better way to document the built-in constants and functions. We can build on this language as we expand the standard library. I like your idea of moving the groovy/java classses to a separate page. I think I'm happy with the changes at this point. Not as much splitting as I wanted but it's a good incremental improvement. I will think about splitting up the types separately. We should be able to do it without adding any more sub-headings I also like the idea of splitting up the process directives, I will try that in a separate PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This all looks really good. Some minor suggestions. Non-blocking.
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@christopher-hakkaart I tried splitting up the stdlib page into multiple sections. Moving each type to its own page isn't feasible right now because it creates too many levels of headings. So instead I just split at the level of constants/functions/types, which reduces the max length by a little bit.
To go all the way, I think we would need to split the "Reference" section into multiple sections:
Language
???
I'm not sure what to call the second section but they seem loosely related. Configuration? User interface? There is also the concept of a "Runtime API" (e.g. the APIs used by plugins) that will need to fit in here one day, somehow.
Anyway, if we can find a sensible hierarchy here, maybe we can move this forward