Use auto-generated docs and show usage information in frame layout #54
Conversation
Use yaml from autogenerated documentation
documentation.html
Outdated
| <button class="row__item button grow" | ||
| onclick="toggleFrame('{{ sub_command.name | replace: ' ', '_' }}-usage')">{{ sub_command.name }}</button> | ||
| </li> | ||
| {% endfor %} |
There was a problem hiding this comment.
I think subcommands should just be shown on the same level as the other commands, without having to click an "expand" button to see them. I'm thinking the fewer clicks one has to make, the better. It also will be easier to work with if subcommands ever have subcommands, which have subcommands... 😅
What do you think?
There was a problem hiding this comment.
Yeah, that makes sense. There's just a lot of sub-commands.
But I'm good with either and can change it
There was a problem hiding this comment.
There's just a lot of sub-commands.
Yeah let's keep it simple for now and not hide them by default, and return to this decision if things really get out of hand.
[EDIT]
As you mentioned in your description, maybe we'll find a way to categorize them, or maybe we'll just dramatically change how we present this information (e.g., embed a WASM nushell in help mode).
|
Cool, I don't mind doing more work on the website, if I can work off your wireframes. |
gentle git gone script
Summary:
_datadirectory to display documentation for the commandsIt's still not perfect... but I think it's an improvement
Future work could be to use categorization instead of just listing all the commands as @kubouch mentioned on discord