jbang
jbang copied to clipboard
Suggestion: Improve Usage/Running documentation
I feel that the split into a "Usage" and "Running" section in the documentation is confusing. If I'm looking for the documentation on how to run things I'd logically assume I'd have to click on the "Running" section. Which then shows me a bunch of options that are only somewhat related to running. If I instead click on the "correct" section, "Usage", I get what I want but funnily enough a bunch of sub-sections there are actually called "Running ...." (Running Groovy, Running Kotlin, Running script..., etc).
So to me that is a good indication that that split is not very intuitive.
My suggestion would be to turn the "Usage" section into a simple explanation on how to use the jbang command in general. For example explaining that each command has a --help. Perhaps an overview of all the toplevel commands with links to each of their sections (not all of them and not in full detail, that's for the "CLI" section of course). The section about "Trust" could stay there. Things like that.
And then "Running" could be dedicated to actually explaining how running code works (which would actually be a good name for the section "Running Code"). The current information from "Usage" and "Running" could be merged into one, because they basically all have to do with running code. (If the problem is that the section would become overly long then we could perhaps split some of it off into an advanced section or something).
WDYT?