Merge pull request #6422 from Shopify/09-23-update_app_dev_documentation

Update app dev documentation

Author: isaacroldan

docs-shopify.dev/commands/app-dev.doc.ts

@@ -3,30 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app dev',
-  description: `[Builds the app](/docs/api/shopify-cli/app/app-build) and lets you preview it on a [development store](/docs/apps/tools/development-stores) or [Plus sandbox store](https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).
-
-> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must \`deploy\` your app.
-
-  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run \`dev\` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using \`dev --reset\` to go through all of them again:
-
-- Associating your project with an app associated with your Partner account or organization, or creating a new app.
-- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.
-- Installing your app on the store using the provided install link.
-- Creating a tunnel between your local environment and the store using Cloudflare.
-
-  You can use your own tunneling software instead, by passing your tunnel URL with the \`--tunnel-url\` flag.
-- Updating the app URLs that are set in the Partner Dashboard.
-
-  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.
-
-- Enabling development store preview for extensions.
-- Serving [GraphiQL for the Admin API](/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.
-- Building and serving your app and app extensions.
-
-If you're using the Ruby app template, then you need to complete the following steps outlined in the [README](https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for the first time.
-
-> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a [staff account](https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.
-`,
+  description: `Builds and previews your app on a development store, and watches for changes. [Read more about testing apps locally](/docs/apps/build/cli-for-apps/test-apps-locally).`,
   overviewPreviewDescription: `Run the app.`,
   type: 'command',
   isVisualComponent: false,

docs-shopify.dev/generated/generated_docs_data.json

@@ -524,7 +524,7 @@
   },
   {
     "name": "app dev",
-    "description": "[Builds the app](/docs/api/shopify-cli/app/app-build) and lets you preview it on a [development store](/docs/apps/tools/development-stores) or [Plus sandbox store](https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).\n\n> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must `deploy` your app.\n\n  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using `dev --reset` to go through all of them again:\n\n- Associating your project with an app associated with your Partner account or organization, or creating a new app.\n- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.\n- Installing your app on the store using the provided install link.\n- Creating a tunnel between your local environment and the store using Cloudflare.\n\n  You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.\n- Updating the app URLs that are set in the Partner Dashboard.\n\n  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.\n\n- Enabling development store preview for extensions.\n- Serving [GraphiQL for the Admin API](/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.\n- Building and serving your app and app extensions.\n\nIf you're using the Ruby app template, then you need to complete the following steps outlined in the [README](https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for the first time.\n\n> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a [staff account](https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.\n",
+    "description": "Builds and previews your app on a development store, and watches for changes. [Read more about testing apps locally](/docs/apps/build/cli-for-apps/test-apps-locally).",
     "overviewPreviewDescription": "Run the app.",
     "type": "command",
     "isVisualComponent": false,

packages/app/src/cli/commands/app/dev.ts

@@ -14,30 +14,7 @@ import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
 export default class Dev extends AppLinkedCommand {
   static summary = 'Run the app.'
 
-  static descriptionWithMarkdown = `[Builds the app](https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a [development store](https://shopify.dev/docs/apps/tools/development-stores) or [Plus sandbox store](https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).
-
-> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must \`deploy\` your app.
-
-  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run \`dev\` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using \`dev --reset\` to go through all of them again:
-
-- Associating your project with an app associated with your Partner account or organization, or creating a new app.
-- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.
-- Installing your app on the store using the provided install link.
-- Creating a tunnel between your local environment and the store using Cloudflare.
-
-  You can use your own tunneling software instead, by passing your tunnel URL with the \`--tunnel-url\` flag.
-- Updating the app URLs that are set in the Partner Dashboard.
-
-  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.
-
-- Enabling development store preview for extensions.
-- Serving [GraphiQL for the Admin API](https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.
-- Building and serving your app and app extensions.
-
-If you're using the Ruby app template, then you need to complete the following steps outlined in the [README](https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for the first time.
-
-> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a [staff account](https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.
-`
+  static descriptionWithMarkdown = `Builds and previews your app on a development store, and watches for changes. [Read more about testing apps locally](https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).`
 
   static description = this.descriptionWithoutMarkdown()
 

packages/cli/README.md

@@ -245,43 +245,8 @@ FLAGS
 DESCRIPTION
   Run the app.
 
-  "Builds the app" (https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a "development
-  store" (https://shopify.dev/docs/apps/tools/development-stores) or "Plus sandbox store"
-  (https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).
-
-  > Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must `deploy` your
-  app.
-
-  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps.
-  If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these
-  configurations using `dev --reset` to go through all of them again:
-
-  - Associating your project with an app associated with your Partner account or organization, or creating a new app.
-  - Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's
-  selected automatically.
-  - Installing your app on the store using the provided install link.
-  - Creating a tunnel between your local environment and the store using Cloudflare.
-
-  You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.
-  - Updating the app URLs that are set in the Partner Dashboard.
-
-  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then
-  you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.
-
-  - Enabling development store preview for extensions.
-  - Serving "GraphiQL for the Admin API"
-  (https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials
-  and access scopes.
-  - Building and serving your app and app extensions.
-
-  If you're using the Ruby app template, then you need to complete the following steps outlined in the "README"
-  (https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for
-  the first time.
-
-  > Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have
-  a "staff account" (https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are
-  created automatically the first time you access a development store with your Partner staff account through the
-  Partner Dashboard.
+  Builds and previews your app on a development store, and watches for changes. "Read more about testing apps locally"
+  (https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).
 ```
 
 ## `shopify app dev clean`

packages/cli/oclif.manifest.json

@@ -396,8 +396,8 @@
       "args": {
       },
       "customPluginName": "@shopify/app",
-      "description": "\"Builds the app\" (https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a \"development store\" (https://shopify.dev/docs/apps/tools/development-stores) or \"Plus sandbox store\" (https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).\n\n> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must `deploy` your app.\n\n  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using `dev --reset` to go through all of them again:\n\n- Associating your project with an app associated with your Partner account or organization, or creating a new app.\n- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.\n- Installing your app on the store using the provided install link.\n- Creating a tunnel between your local environment and the store using Cloudflare.\n\n  You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.\n- Updating the app URLs that are set in the Partner Dashboard.\n\n  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.\n\n- Enabling development store preview for extensions.\n- Serving \"GraphiQL for the Admin API\" (https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.\n- Building and serving your app and app extensions.\n\nIf you're using the Ruby app template, then you need to complete the following steps outlined in the \"README\" (https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for the first time.\n\n> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a \"staff account\" (https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.\n",
-      "descriptionWithMarkdown": "[Builds the app](https://shopify.dev/docs/api/shopify-cli/app/app-build) and lets you preview it on a [development store](https://shopify.dev/docs/apps/tools/development-stores) or [Plus sandbox store](https://help.shopify.com/partners/dashboard/managing-stores/plus-sandbox-store).\n\n> Note: Development store preview of extension drafts is not supported for Plus sandbox stores. You must `deploy` your app.\n\n  To preview your app on a development store or Plus sandbox store, Shopify CLI walks you through the following steps. If you've run `dev` before, then your settings are saved and some of these steps are skipped. You can reset these configurations using `dev --reset` to go through all of them again:\n\n- Associating your project with an app associated with your Partner account or organization, or creating a new app.\n- Selecting a development store or Plus sandbox store to use for testing. If you have only one store, then it's selected automatically.\n- Installing your app on the store using the provided install link.\n- Creating a tunnel between your local environment and the store using Cloudflare.\n\n  You can use your own tunneling software instead, by passing your tunnel URL with the `--tunnel-url` flag.\n- Updating the app URLs that are set in the Partner Dashboard.\n\n  To avoid overwriting any URLs that are already set, select the No, never option. If you select this option, then you're provided with URLs that you can manually add in the Partner Dashboard so you can preview your app.\n\n- Enabling development store preview for extensions.\n- Serving [GraphiQL for the Admin API](https://shopify.dev/docs/apps/tools/graphiql-admin-api#use-a-local-graphiql-instance) using your app's credentials and access scopes.\n- Building and serving your app and app extensions.\n\nIf you're using the Ruby app template, then you need to complete the following steps outlined in the [README](https://github.com/Shopify/shopify-app-template-ruby#setting-up-your-rails-app) before you can preview your app for the first time.\n\n> Caution: To use a development store or Plus sandbox store with Shopify CLI, you need to be the store owner, or have a [staff account](https://help.shopify.com/manual/your-account/staff-accounts) on the store. Staff accounts are created automatically the first time you access a development store with your Partner staff account through the Partner Dashboard.\n",
+      "description": "Builds and previews your app on a development store, and watches for changes. \"Read more about testing apps locally\" (https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).",
+      "descriptionWithMarkdown": "Builds and previews your app on a development store, and watches for changes. [Read more about testing apps locally](https://shopify.dev/docs/apps/build/cli-for-apps/test-apps-locally).",
       "flags": {
         "api-key": {
           "description": "The API key of your app.",