handbook icon indicating copy to clipboard operation
handbook copied to clipboard

Restructure command reference

Open schlessera opened this issue 8 years ago • 0 comments

The current command reference has the following page structure:

- fontpage
  +- command
     +- subcommand
     +- subcommand
  +- command
     +- subcommand
     +- subcommand

The problem with this is that it the frontpage itself is practically empty. It only contains a list command roots together with their (very brief) description:

Command Description
wp post Manage posts.
wp post-type Manage post types.

This page is rather useless on its own, and is basically an oversized navigation menu.

I'd suggest looking into eliminating the second level by adding all command information directly to the frontpage, as an accordeon or similar interface:

Command Description
wp post Manage posts.
+-- wp post create Create a new post.
+-- wp post delete Delete an existing post.
wp post-type Manage post types.
+-- wp post-type get Get details about a registered post type.
+-- wp post-type list List registered post types.

We can then add an instant search box to that page, which will expand the accordeoan as needed and filter/highlight the lists.

So, in the example above, if I'd type delete in the search box, the page would immediately shrink to this:

Command Description
wp post Manage posts.
+-- wp post delete Delete an existing post.

This will give a proper purpose to this page, as people can easily discover what command they are looking for (provided we improve the descriptions).

schlessera avatar Aug 16 '17 05:08 schlessera