[docs] Initial addition of CLI Reference docs #24754
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Cheney-W
added
the
category:documentation
There was a problem hiding this comment.
Please excuse extreme nitpicks. I think the big overall themes are:
- Passive voice is bad.
- I think we should consistently use "port" when that's what we're talking about in new docs.
- Not wanting to codify "all commands accept Xxx" for commands that do nothing with those values.
Also I think it would be good for Augustin to at least read this.
|
Waiting for #24764 so I can get some validation :) |
docs/commands/common-options.md
Outdated
|
|
||
| <a name="x-asset-sources"></a> | ||
|
|
||
| ## `--x-asset-sources=<config>` |
There was a problem hiding this comment.
Should we move experimental options to the bottom of the list?
There was a problem hiding this comment.
No, the x- prefix should be treated like the when sorting phrases.
The intended path of experimental functionality (90% of the time) is to drop the prefix when stable and continue accepting the old name. This ensures maximum compatibility with existing scripts.
We could consider an entirely separate section for experimental functionality, but I feel that's unnecessary and unusual as long as they're clearly marked.
This PR introduces a Command Line Reference section to the documentation along with the first documented command (
install).