docs: Add summary to docs and fix command descriptions #1062
Conversation
The command descriptions now follow the new extension terminology: https://wiki.mozilla.org/Add-ons/Terminology
README.md
Outdated
| @@ -17,6 +17,19 @@ cross-platform way. Initially, it will provide a streamlined experience for deve | |||
| * [Getting started with web-ext](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext) | |||
| * [Command reference](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/web-ext_command_reference) | |||
|
|
|||
| Here are the commands you can run. Click on each one for detailed documentation or use `--help` on the command line, such as `web-ext --help build`. | |||
There was a problem hiding this comment.
nit, not a big deal (and I'm pretty sure that with yargs the order doesn't matter), but as a command line user I'm more used to see the opposite web-ext build --help
There was a problem hiding this comment.
Good call. That's more intuitive too since you may start typing web-ext run ... and then realize you don't know the name of some option.
README.md
Outdated
| @@ -17,6 +17,19 @@ cross-platform way. Initially, it will provide a streamlined experience for deve | |||
| * [Getting started with web-ext](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext) | |||
| * [Command reference](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/web-ext_command_reference) | |||
|
|
|||
| Here are the commands you can run. Click on each one for detailed documentation or use `--help` on the command line, such as `web-ext --help build`. | |||
|
|
|||
| * [`build`](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/web-ext_command_reference#web-ext_build) | |||
There was a problem hiding this comment.
I'm wondering if it would be better to order them based on how much they are actually used (and useful) or just ordering them alphabetically.
If we opt for ordering them by "number of times you will actually use the command", I would say:
- run, build, lint, sign, docs
or - run, lint, build, sign, docs
There was a problem hiding this comment.
Sure. The first ordering is what I would think. I'll change it to that.
There was a problem hiding this comment.
well, actually, build really isn't so useful. This comes to mind after more thought: run, lint, sign, build, docs
The command descriptions now follow the new extension terminology: https://wiki.mozilla.org/Add-ons/Terminology