Effect CommunityEC
Effect Community•6mo ago•
6 replies
kit

Suggestions for Concise Help Documentation

I'm just sharing some random design thoughts:

Verbose Help

The help documents seem a bit verbose, especially for the built-in options. They tend to push the docs for user-defined options off-screen. Maybe we could make them more concise and/or explore some other help formatting options:

(-h, --help)

  A true or false value.

  Show the help documentation for a command

  This setting is optional.

--wizard

  A true or false value.

  Start wizard mode for a command

  This setting is optional.

--version

  A true or false value.

  Show the version of the application

  This setting is optional.
Was this page helpful?