docs: refine cli documentation #2151
Conversation
| ## Usage | ||
|
|
||
| ```bash | ||
| vuepress <command> targetDir [options] |
There was a problem hiding this comment.
Why removing targetDir?
There was a problem hiding this comment.
vuepress info command does not require targetDir
There was a problem hiding this comment.
Then the other commands miss targetDir
There was a problem hiding this comment.
I think that's the difference between vuepress --help and vuepress dev --help?
There was a problem hiding this comment.
Well, some people won't realize that they have to pass targetDir at first glance. In this case, how about rewriting Usage in each section?
There was a problem hiding this comment.
After reviewing it again, I think I'm not making too much improvement 😅Really sorry about that, will do more research next time. Does it look a bit better now?
|
The Chinese translation hasn't been finished |
Summary
checkEnv.jsWill update Chinese doc after review
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx], where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Best wishes to all those fighting the coronavirus in China and all over the world