Skip to content

Commit c23e7d3

Browse files
W-21371395: fix: edit the help, add a topic desc for "lightning" (#634)
* fix: edit the help, add a topic desc for "lightning" * fix: update the link to LWC dev guide --------- Co-authored-by: Abdulsattar Mohammed <abdulsattarmohammed@salesforce.com>
1 parent 0462fff commit c23e7d3

4 files changed

Lines changed: 31 additions & 20 deletions

File tree

messages/lightning.dev.app.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Preview a Lightning Experience app locally and in real-time, without deploying i
44

55
# description
66

7-
Use Local Dev (Beta) to see local changes to your app in a real-time preview that you don't have to deploy or manually refresh. To let you quickly iterate on your Lightning web components (LWCs) and pages, your app preview automatically refreshes when Local Dev detects source code changes.
7+
Use Local Dev to see local changes to your app in a real-time preview that you don't have to deploy or manually refresh. To let you quickly iterate on your Lightning web components (LWCs) and pages, your app preview automatically refreshes when Local Dev detects source code changes.
88

99
When you edit these local files with Local Dev enabled, your org automatically reflects these changes.
1010

@@ -17,7 +17,9 @@ To apply any other local changes not listed above, you must deploy them to your
1717

1818
When you make changes directly in your org (like saving new component properties), they're automatically deployed to your live app. To update your local version of the app with those changes, you must retrieve them from your org using the `sf project retrieve start` command.
1919

20-
To learn more about Local Dev enablement, considerations, and limitations, see the Lightning Web Components Developer Guide.
20+
If you run the command without flags, it displays a list of devices for you to choose from. Then it lists the apps that it found in your local DX project for you to choose. Use the --device or --name flags to bypass the questions. The command also asks if you want to enable Local Dev in your org if it isn't already.
21+
22+
To learn more about Local Dev enablement, considerations, and limitations, see the Lightning Web Components Developer Guide (https://developer.salesforce.com/docs/platform/lwc/guide/get-started-test-components.html).
2123

2224
# flags.name.summary
2325

@@ -33,15 +35,15 @@ ID of the mobile device to display the preview if device type is set to `ios` or
3335

3436
# error.fetching.app-id
3537

36-
Unable to determine App Id for %s
38+
Unable to determine App Id for %s.
3739

3840
# error.device.notfound
3941

40-
Unable to find device %s
42+
Unable to find device %s.
4143

4244
# error.device.google.play
4345

44-
Google Play devices are not supported. %s is a Google Play device. Please use a Google APIs device instead.
46+
Google Play devices aren't supported. %s is a Google Play device. Use a Google APIs device instead.
4547

4648
# spinner.device.boot
4749

@@ -87,7 +89,9 @@ Note: Your desktop browser requires additional configuration to trust the local
8789

8890
- Preview the default app for the target org "myOrg" in a desktop environment:
8991
<%= config.bin %> <%= command.id %> --target-org myOrg
92+
9093
- Preview the app "myApp" for the target org "myOrg" in a desktop environment:
9194
<%= config.bin %> <%= command.id %> --name MyApp --target-org myOrg --device-type desktop
95+
9296
- Preview the default app for target org "myOrg" on an iOS device:
9397
<%= config.bin %> <%= command.id %> --target-org myOrg --device-type ios --device-id "iPhone 15 Pro Max"
Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# summary
22

3-
[Beta] Preview LWC components in isolation.
3+
Preview LWC components in isolation.
44

55
# description
66

@@ -14,35 +14,38 @@ When running the development server, these changes are immediately reflected:
1414
- Adding or updating internal component dependencies
1515
- Modifying static resources used by the component
1616

17-
See the LWC Development Guide for more information about component development best practices and limitations.
17+
If you run the command without flags, it displays a list of components that it found in your local DX project for you to choose to preview. Use the --name flag to bypass the question. The command also asks if you want to enable Local Dev in your org if it isn't already.
18+
19+
See the LWC Developer Guide for more information about component development best practices and limitations (https://developer.salesforce.com/docs/platform/lwc/guide/get-started-best-practices.html).
1820

1921
# flags.name.summary
2022

2123
Name of a component to preview.
2224

2325
# flags.client-select.summary
2426

25-
Launch component preview without selecting a component
27+
Launch component preview without selecting a component.
2628

2729
# error.directory
2830

29-
Unable to find components
31+
Unable to find components.
3032

3133
# error.component
3234

33-
Unable to determine component name
35+
Unable to determine component name.
3436

3537
# error.component-metadata
3638

37-
Failed to parse component metadata at: %s
39+
Failed to parse component metadata at: %s.
3840

3941
# error.component-not-found
4042

41-
Unable to find component with name: %s
43+
Unable to find component with name: %s.
4244

4345
# examples
4446

45-
- Select a component and launch the component preview:
47+
- Select a component interactively and launch the component preview; use your default org:
4648
<%= config.bin %> <%= command.id %>
47-
- Launch component preview for "myComponent":
48-
<%= config.bin %> <%= command.id %> --name myComponent
49+
50+
- Launch component preview for "myComponent"; use the org with alias "myscratch":
51+
<%= config.bin %> <%= command.id %> --name myComponent --target-org myscratch

messages/lightning.dev.site.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# summary
22

3-
[Beta] Preview an Experience Builder site locally and in real-time, without deploying it.
3+
Preview an Experience Builder site locally and in real-time, without deploying it.
44

55
# description
66

@@ -15,15 +15,18 @@ When you edit these local files with Local Dev enabled, your org automatically r
1515

1616
To apply any other local changes not listed above, you must deploy them to your org using the `sf project deploy start` command. Then republish your site and restart the server for the Local Dev experience.
1717

18+
If you run the command without flags, it displays a list of Experience Builder sites that it found in your local DX project for you to choose from. Use the --name flag to bypass the question. The command also asks if you want to enable Local Dev in your org if it isn't already.
19+
1820
For more considerations and limitations, see the Lightning Web Components Developer Guide.
1921

2022
# flags.name.summary
2123

22-
Name of the Experience Builder site to preview. It has to match a site name from the current org.
24+
Name of the Experience Builder site to preview. It must match a site name from the current org.
2325

2426
# examples
2527

26-
- Select a site to preview from the org "myOrg":
28+
- Select a site to preview from the org with alias "myOrg":
2729
<%= config.bin %> <%= command.id %> --target-org myOrg
28-
- Preview the site "Partner Central" from the org "myOrg":
29-
<%= config.bin %> <%= command.id %> --name "Partner Central" --target-org myOrg
30+
31+
- Preview the site "Partner Central" from your default org:
32+
<%= config.bin %> <%= command.id %> --name "Partner Central"

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
"topics": {
8181
"lightning": {
8282
"external": true,
83+
"description": "Commands to work with Lightning applications.",
8384
"subtopics": {
8485
"dev": {
8586
"description": "Preview applications and sites locally and in real-time, without deploying them."

0 commit comments

Comments
 (0)