From d752993a250b3a34d38c0de6119f786dcae350fb Mon Sep 17 00:00:00 2001 From: Juliet Shackell Date: Thu, 26 Feb 2026 11:51:28 -0800 Subject: [PATCH 1/2] fix: edit the help, add a topic desc for "lightning" --- messages/lightning.dev.app.md | 14 +++++++++----- messages/lightning.dev.component.md | 23 +++++++++++++---------- messages/lightning.dev.site.md | 14 +++++++++----- package.json | 1 + 4 files changed, 32 insertions(+), 20 deletions(-) diff --git a/messages/lightning.dev.app.md b/messages/lightning.dev.app.md index ce3765f9..1f8f0aa4 100644 --- a/messages/lightning.dev.app.md +++ b/messages/lightning.dev.app.md @@ -4,7 +4,7 @@ Preview a Lightning Experience app locally and in real-time, without deploying i # description -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. +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. When you edit these local files with Local Dev enabled, your org automatically reflects these changes. @@ -17,7 +17,9 @@ To apply any other local changes not listed above, you must deploy them to your 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. -To learn more about Local Dev enablement, considerations, and limitations, see the Lightning Web Components Developer Guide. +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. + +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-introduction.html). # flags.name.summary @@ -33,15 +35,15 @@ ID of the mobile device to display the preview if device type is set to `ios` or # error.fetching.app-id -Unable to determine App Id for %s +Unable to determine App Id for %s. # error.device.notfound -Unable to find device %s +Unable to find device %s. # error.device.google.play -Google Play devices are not supported. %s is a Google Play device. Please use a Google APIs device instead. +Google Play devices aren't supported. %s is a Google Play device. Use a Google APIs device instead. # spinner.device.boot @@ -87,7 +89,9 @@ Note: Your desktop browser requires additional configuration to trust the local - Preview the default app for the target org "myOrg" in a desktop environment: <%= config.bin %> <%= command.id %> --target-org myOrg + - Preview the app "myApp" for the target org "myOrg" in a desktop environment: <%= config.bin %> <%= command.id %> --name MyApp --target-org myOrg --device-type desktop + - Preview the default app for target org "myOrg" on an iOS device: <%= config.bin %> <%= command.id %> --target-org myOrg --device-type ios --device-id "iPhone 15 Pro Max" diff --git a/messages/lightning.dev.component.md b/messages/lightning.dev.component.md index 6fc3aab0..aa7d8415 100644 --- a/messages/lightning.dev.component.md +++ b/messages/lightning.dev.component.md @@ -1,6 +1,6 @@ # summary -[Beta] Preview LWC components in isolation. +Preview LWC components in isolation. # description @@ -14,7 +14,9 @@ When running the development server, these changes are immediately reflected: - Adding or updating internal component dependencies - Modifying static resources used by the component -See the LWC Development Guide for more information about component development best practices and limitations. +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. + +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). # flags.name.summary @@ -22,27 +24,28 @@ Name of a component to preview. # flags.client-select.summary -Launch component preview without selecting a component +Launch component preview without selecting a component. # error.directory -Unable to find components +Unable to find components. # error.component -Unable to determine component name +Unable to determine component name. # error.component-metadata -Failed to parse component metadata at: %s +Failed to parse component metadata at: %s. # error.component-not-found -Unable to find component with name: %s +Unable to find component with name: %s. # examples -- Select a component and launch the component preview: +- Select a component interactively and launch the component preview; use your default org: <%= config.bin %> <%= command.id %> -- Launch component preview for "myComponent": - <%= config.bin %> <%= command.id %> --name myComponent + +- Launch component preview for "myComponent"; use the org with alias "myscratch": + <%= config.bin %> <%= command.id %> --name myComponent --target-org myscratch diff --git a/messages/lightning.dev.site.md b/messages/lightning.dev.site.md index 20fd1011..604a2f89 100644 --- a/messages/lightning.dev.site.md +++ b/messages/lightning.dev.site.md @@ -1,6 +1,6 @@ # summary -[Beta] Preview an Experience Builder site locally and in real-time, without deploying it. +Preview an Experience Builder site locally and in real-time, without deploying it. # description @@ -15,11 +15,13 @@ When you edit these local files with Local Dev enabled, your org automatically r 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. +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. + For more considerations and limitations, see the Lightning Web Components Developer Guide. # flags.name.summary -Name of the Experience Builder site to preview. It has to match a site name from the current org. +Name of the Experience Builder site to preview. It must match a site name from the current org. # flags.get-latest.summary @@ -31,13 +33,15 @@ Preview the site as a guest user (rather than an authenticated user). # flags.ssr.summary -Preview the SSR bundle +Preview the server-side rendering (SSR) bundle. # examples - Select a site to preview from the org "myOrg": <%= config.bin %> <%= command.id %> --target-org myOrg -- Preview the site "Partner Central" from the org "myOrg": - <%= config.bin %> <%= command.id %> --name "Partner Central" --target-org myOrg + +- Preview the site "Partner Central" from your default org: + <%= config.bin %> <%= command.id %> --name "Partner Central" + - Get and preview the latest version of the "Partner Central" site from the org "myOrg" <%= config.bin %> <%= command.id %> --name "Partner Central" --target-org myOrg --get-latest diff --git a/package.json b/package.json index 152bbaea..2c8f17c9 100644 --- a/package.json +++ b/package.json @@ -78,6 +78,7 @@ "topics": { "lightning": { "external": true, + "description": "Commands to work with Lightning applications.", "subtopics": { "dev": { "description": "Preview applications and sites locally and in real-time, without deploying them." From 0209a7b5472e44dfae50b31bd212fbd26941b442 Mon Sep 17 00:00:00 2001 From: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> Date: Fri, 27 Feb 2026 10:43:42 -0800 Subject: [PATCH 2/2] fix: update the link to LWC dev guide --- messages/lightning.dev.app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/messages/lightning.dev.app.md b/messages/lightning.dev.app.md index 1f8f0aa4..505fd44a 100644 --- a/messages/lightning.dev.app.md +++ b/messages/lightning.dev.app.md @@ -19,7 +19,7 @@ When you make changes directly in your org (like saving new component properties 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. -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-introduction.html). +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). # flags.name.summary