ideas icon indicating copy to clipboard operation
ideas copied to clipboard

Improve user experience of the help screens

Open danielbachhuber opened this issue 7 years ago • 0 comments

This is a placeholder issue for potential improvements to the help screens:

  • Show disabled commands with the reason why they were disabled
  • Extended help view, or a man page
  • Web links in console output

Show disabled commands with the reason why they were disabled

commands-dependency-mockup

From https://github.com/wp-cli/wp-cli/issues/4035


Extended help view, or a man page

I find that the single-page layout of a man page aids with the discoverability of features of a command. While I'm looking for details of the option I need help with, I often see something that I wasn't previously aware of or had forgotten.

This sort of discoverability doesn't exist in the wp help command as it only lists the top level subcommands. Some form of extended help view which lists the description and complete synopsis for every available command could help with discoverability. A trimmed example is below.

$ man wp
NAME

  wp

DESCRIPTION

  Manage WordPress through the command-line.

SYNOPSIS

  wp <command>

SUBCOMMANDS

  wp cache add <key> <value> [<group>] [<expiration>]
          Add a value to the object cache.

  wp cache decr <key> [<offset>] [<group>]
          Decrement a value in the object cache.

From https://github.com/wp-cli/wp-cli/issues/4565


Web links in console output

If we want to bridge the gap between the console (where the "product" is being used) and the web (where the "product" is being documented and worked on), we need to define in what form hyperlinks can or should be used in console output.

See https://github.com/wp-cli/wp-cli/issues/4158

danielbachhuber avatar Dec 14 '17 19:12 danielbachhuber