Skip to content

Commit 48eea53

Browse files
committed
docs: align command documentation with spec requirements
1 parent 1906135 commit 48eea53

File tree

4 files changed

+6
-14
lines changed

4 files changed

+6
-14
lines changed

COMMANDS.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,9 @@ EXAMPLES
3636
3737
$ sf webapp deploy --name myWebApp
3838
39-
Deploy a web app with build option:
39+
Deploy a web app with specific options:
4040
4141
$ sf webapp deploy --name myWebApp --options build
42-
43-
Validate a web app deployment:
44-
45-
$ sf webapp deploy --name myWebApp --options validate
4642
```
4743

4844
## `sf webapp dev`
@@ -57,7 +53,7 @@ USAGE
5753
FLAGS
5854
-n, --name=<value> (required) Identifies the Web Application
5955
-p, --port=<value> [default: 8080] Port for the dev server
60-
-r, --root-dir=<value> Optional override for the local project root of this Web Application
56+
-r, --root-dir=<value> Optional override for the local project root of the given Web Application
6157
-t, --target=<value> Selects which Web Application target to use for the preview (e.g., Lightning App, Site)
6258
--host=<value> [default: localhost] Host to bind to
6359
--no-open Do not automatically open the browser
@@ -116,7 +112,7 @@ GLOBAL FLAGS
116112
--json Format output as json.
117113
118114
DESCRIPTION
119-
Create a web app and associated metadata
115+
Create a web app and associated metadata.
120116
121117
This command creates a new web app with the specified configuration, including the basic structure and metadata
122118
files.

messages/webapp.deploy.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@ Deployment options (build or validate)
2020

2121
<%= config.bin %> <%= command.id %> --name myWebApp
2222

23-
- Deploy a web app with build option:
23+
- Deploy a web app with specific options:
2424

2525
<%= config.bin %> <%= command.id %> --name myWebApp --options build
26-
27-
- Validate a web app deployment:
28-
29-
<%= config.bin %> <%= command.id %> --name myWebApp --options validate

messages/webapp.dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Selects which Web Application target to use for the preview (e.g., Lightning App
1616

1717
# flags.root-dir.summary
1818

19-
Optional override for the local project root of this Web Application
19+
Optional override for the local project root of the given Web Application
2020

2121
# flags.port.summary
2222

messages/webapp.generate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# summary
22

3-
Create a web app and associated metadata
3+
Create a web app and associated metadata.
44

55
# description
66

0 commit comments

Comments
 (0)