From 629835a1a67fd756554966ae55df373dd2deb30d Mon Sep 17 00:00:00 2001 From: Kyle Bavender Date: Tue, 6 Jan 2026 16:52:39 -0500 Subject: [PATCH] update URLs in description for app generate extension MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Alvaro Gutierrez , Co-authored-by: Pierre-Olivier Bédard --- .changeset/dry-files-fold.md | 5 +++++ docs-shopify.dev/commands/app-generate-extension.doc.ts | 4 ++-- docs-shopify.dev/generated/generated_docs_data.json | 2 +- docs/cli/conventions.md | 2 +- packages/app/src/cli/commands/app/generate/extension.ts | 4 ++-- packages/cli/README.md | 9 +++++---- packages/cli/oclif.manifest.json | 4 ++-- 7 files changed, 18 insertions(+), 12 deletions(-) create mode 100644 .changeset/dry-files-fold.md diff --git a/.changeset/dry-files-fold.md b/.changeset/dry-files-fold.md new file mode 100644 index 00000000000..c4a73c91af5 --- /dev/null +++ b/.changeset/dry-files-fold.md @@ -0,0 +1,5 @@ +--- +'@shopify/app': patch +--- + +Update link URLs for shopify app generate extension description diff --git a/docs-shopify.dev/commands/app-generate-extension.doc.ts b/docs-shopify.dev/commands/app-generate-extension.doc.ts index 6d12ec0dde8..1d1a1cb4a90 100644 --- a/docs-shopify.dev/commands/app-generate-extension.doc.ts +++ b/docs-shopify.dev/commands/app-generate-extension.doc.ts @@ -3,9 +3,9 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' const data: ReferenceEntityTemplateSchema = { name: 'app generate extension', - description: `Generates a new [app extension](/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](/docs/apps/structure/app-extensions/list). + description: `Generates a new [app extension](/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](/docs/apps/build/app-extensions/list-of-app-extensions). - Each new app extension is created in a folder under \`extensions/\`. To learn more about the extensions file structure, refer to [App structure](/docs/apps/tools/cli/structure) and the documentation for your extension. + Each new app extension is created in a folder under \`extensions/\`. To learn more about the extensions file structure, refer to [App structure](/docs/apps/build/cli-for-apps/app-structure) and the documentation for your extension. `, overviewPreviewDescription: `Generate a new app Extension.`, type: 'command', diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json index 0d1e110a135..4e116559459 100644 --- a/docs-shopify.dev/generated/generated_docs_data.json +++ b/docs-shopify.dev/generated/generated_docs_data.json @@ -1624,7 +1624,7 @@ }, { "name": "app generate extension", - "description": "Generates a new [app extension](/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](/docs/apps/structure/app-extensions/list).\n\n Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to [App structure](/docs/apps/tools/cli/structure) and the documentation for your extension.\n ", + "description": "Generates a new [app extension](/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](/docs/apps/build/app-extensions/list-of-app-extensions).\n\n Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to [App structure](/docs/apps/build/cli-for-apps/app-structure) and the documentation for your extension.\n ", "overviewPreviewDescription": "Generate a new app Extension.", "type": "command", "isVisualComponent": false, diff --git a/docs/cli/conventions.md b/docs/cli/conventions.md index db4b7fbf351..fd17816ff49 100644 --- a/docs/cli/conventions.md +++ b/docs/cli/conventions.md @@ -12,7 +12,7 @@ Default exports force the module importer to decide on a name, which leads to in import { join } from "node:path" ``` -A better name for the above function would have beeen: +A better name for the above function would have been: ```ts import { joinPath } from "node:path" diff --git a/packages/app/src/cli/commands/app/generate/extension.ts b/packages/app/src/cli/commands/app/generate/extension.ts index 36b0ba309db..ffb81c0ec65 100644 --- a/packages/app/src/cli/commands/app/generate/extension.ts +++ b/packages/app/src/cli/commands/app/generate/extension.ts @@ -11,9 +11,9 @@ import {renderWarning} from '@shopify/cli-kit/node/ui' export default class AppGenerateExtension extends AppLinkedCommand { static summary = 'Generate a new app Extension.' - static descriptionWithMarkdown = `Generates a new [app extension](https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/structure/app-extensions/list). + static descriptionWithMarkdown = `Generates a new [app extension](https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/build/app-extensions/list-of-app-extensions). - Each new app extension is created in a folder under \`extensions/\`. To learn more about the extensions file structure, refer to [App structure](https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension. + Each new app extension is created in a folder under \`extensions/\`. To learn more about the extensions file structure, refer to [App structure](https://shopify.dev/docs/apps/build/cli-for-apps/app-structure) and the documentation for your extension. ` static description = this.descriptionWithoutMarkdown() diff --git a/packages/cli/README.md b/packages/cli/README.md index c01aaaa8d26..452dfaf44e4 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -541,12 +541,13 @@ FLAGS DESCRIPTION Generate a new app Extension. - Generates a new "app extension" (https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you - can generate using this command, refer to "Supported extensions" - (https://shopify.dev/docs/apps/structure/app-extensions/list). + Generates a new "app extension" (https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions + that you can generate using this command, refer to "Supported extensions" + (https://shopify.dev/docs/apps/build/app-extensions/list-of-app-extensions). Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, - refer to "App structure" (https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension. + refer to "App structure" (https://shopify.dev/docs/apps/build/cli-for-apps/app-structure) and the documentation for + your extension. ``` ## `shopify app import-custom-data-definitions` diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json index 14650db5415..963e104b6b4 100644 --- a/packages/cli/oclif.manifest.json +++ b/packages/cli/oclif.manifest.json @@ -1927,8 +1927,8 @@ "args": { }, "customPluginName": "@shopify/app", - "description": "Generates a new \"app extension\" (https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to \"Supported extensions\" (https://shopify.dev/docs/apps/structure/app-extensions/list).\n\n Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to \"App structure\" (https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.\n ", - "descriptionWithMarkdown": "Generates a new [app extension](https://shopify.dev/docs/apps/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/structure/app-extensions/list).\n\n Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to [App structure](https://shopify.dev/docs/apps/tools/cli/structure) and the documentation for your extension.\n ", + "description": "Generates a new \"app extension\" (https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to \"Supported extensions\" (https://shopify.dev/docs/apps/build/app-extensions/list-of-app-extensions).\n\n Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to \"App structure\" (https://shopify.dev/docs/apps/build/cli-for-apps/app-structure) and the documentation for your extension.\n ", + "descriptionWithMarkdown": "Generates a new [app extension](https://shopify.dev/docs/apps/build/app-extensions). For a list of app extensions that you can generate using this command, refer to [Supported extensions](https://shopify.dev/docs/apps/build/app-extensions/list-of-app-extensions).\n\n Each new app extension is created in a folder under `extensions/`. To learn more about the extensions file structure, refer to [App structure](https://shopify.dev/docs/apps/build/cli-for-apps/app-structure) and the documentation for your extension.\n ", "flags": { "client-id": { "description": "The Client ID of your app.",