Skip to content

update URLs in description for app generate extension #6742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kbav wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update URLs in description for app generate extension #6742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dry-files-fold.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/app': patch
---

Update link URLs for shopify app generate extension description
4 changes: 2 additions & 2 deletions docs-shopify.dev/commands/app-generate-extension.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion docs-shopify.dev/generated/generated_docs_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions packages/app/src/cli/commands/app/generate/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
9 changes: 5 additions & 4 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/oclif.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down
Loading