update generate docs to v1.1.1

bin/create-doc-pr.js

@@ -15,7 +15,7 @@ async function createPR() {
 
   const generatedDirectory = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "../docs-shopify.dev/generated")
 
-  const fileNames = ['generated_category_pages.json', 'generated_docs_data.json', 'generated_static_pages.json']
+  const fileNames = ['generated_category_pages.json', 'generated_docs_data.json', 'generated_docs_data_v2.json', 'generated_static_pages.json']
 
   const files = {}
   for (const fileName of fileNames) {

bin/docs/build-dev-docs.sh

@@ -15,3 +15,14 @@ eval $COMPILE_DOCS
 eval $COMPILE_STATIC_PAGES
 eval $COMPILE_CATEGORY_PAGES
 echo "DONE"
+
+# Copy generated docs to shopify-dev in the world repo if available
+WORLD_DEST="$HOME/world/trees/root/src/areas/platforms/shopify-dev/db/data/docs/templated_apis/shopify_cli"
+if [ -d "$WORLD_DEST" ]; then
+  for file in generated_docs_data.json generated_docs_data_v2.json generated_static_pages.json generated_category_pages.json; do
+    if [ -f "./docs-shopify.dev/generated/$file" ]; then
+      cp "./docs-shopify.dev/generated/$file" "$WORLD_DEST/$file"
+      echo "Copied $file to $WORLD_DEST"
+    fi
+  done
+fi

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

@@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app build',
-  description: `This command executes the build script specified in the element's TOML file. You can specify a custom script in the file. To learn about configuration files in Shopify apps, refer to [App configuration](/docs/apps/tools/cli/configuration).
-
-  If you're building a [theme app extension](/docs/apps/online-store/theme-app-extensions), then running the \`build\` command runs [Theme Check](/docs/themes/tools/theme-check) against your extension to ensure that it's valid.`,
+  description: `The following flags are available for the \`app build\` command:`,
   overviewPreviewDescription: `Build the app, including extensions.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app bulk cancel',
-  description: `Cancels a running bulk operation by ID.`,
+  description: `The following flags are available for the \`app bulk cancel\` command:`,
   overviewPreviewDescription: `Cancel a bulk operation.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,11 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app bulk execute',
-  description: `Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.
-
-  Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).
-
-  Use [\`bulk status\`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.`,
+  description: `The following flags are available for the \`app bulk execute\` command:`,
   overviewPreviewDescription: `Execute bulk operations.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,11 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app bulk status',
-  description: `Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days.
-
-  Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).
-
-  Use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.`,
+  description: `The following flags are available for the \`app bulk status\` command:`,
   overviewPreviewDescription: `Check the status of bulk operations.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,10 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app config link',
-  description: `Pulls app configuration from the Developer Dashboard and creates or overwrites a configuration file. You can create a new app with this command to start with a default configuration file.
-
-  For more information on the format of the created TOML configuration file, refer to the [App configuration](/docs/apps/tools/cli/configuration) page.
-  `,
+  description: `The following flags are available for the \`app config link\` command:`,
   overviewPreviewDescription: `Fetch your app configuration from the Developer Dashboard.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app config pull',
-  description: `Pulls the latest configuration from the already-linked Shopify app and updates the selected configuration file.
-
-This command reuses the existing linked app and organization and skips all interactive prompts. Use \`--config\` to target a specific configuration file, or omit it to use the default one.`,
+  description: `The following flags are available for the \`app config pull\` command:`,
   overviewPreviewDescription: `Refresh an already-linked app configuration without prompts.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app config use',
-  description: `Sets default configuration when you run app-related CLI commands. If you omit the \`config-name\` parameter, then you'll be prompted to choose from the configuration files in your project.`,
+  description: `The following flags are available for the \`app config use\` command:`,
   overviewPreviewDescription: `Activate an app configuration.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app config validate',
-  description: `Validates the selected app configuration file and all extension configurations against their schemas and reports any errors found.`,
+  description: `The following flags are available for the \`app config validate\` command:`,
   overviewPreviewDescription: `Validate your app configuration and extensions.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,12 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app deploy',
-  description: `[Builds the app](/docs/api/shopify-cli/app/app-build), then deploys your app configuration and extensions.
-
-  This command creates an app version, which is a snapshot of your app configuration and all extensions. This version is then released to users.
-
-  This command doesn't deploy your [web app](/docs/apps/tools/cli/structure#web-components). You need to [deploy your web app](/docs/apps/deployment/web) to your own hosting solution.
-  `,
+  description: `The following flags are available for the \`app deploy\` command:`,
   overviewPreviewDescription: `Deploy your Shopify app.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,10 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app dev clean',
-  description: `Stop the dev preview that was started with \`shopify app dev\`.
-
-  It restores the app's active version to the selected development store.
-  `,
+  description: `The following flags are available for the \`app dev clean\` command:`,
   overviewPreviewDescription: `Cleans up the dev preview from the selected store.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app dev',
-  description: `Builds and previews your app on a dev store, and watches for changes. [Read more about testing apps locally](/docs/apps/build/cli-for-apps/test-apps-locally).`,
+  description: `The following flags are available for the \`app dev\` command:`,
   overviewPreviewDescription: `Run the app.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app env pull',
-  description: `Creates or updates an \`.env\` files that contains app and app extension environment variables.
-
-  When an existing \`.env\` file is updated, changes to the variables are displayed in the terminal output. Existing variables and commented variables are preserved.`,
+  description: `The following flags are available for the \`app env pull\` command:`,
   overviewPreviewDescription: `Pull app and extensions environment variables.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app env show',
-  description: `Displays environment variables that can be used to deploy apps and app extensions.`,
+  description: `The following flags are available for the \`app env show\` command:`,
   overviewPreviewDescription: `Display app and extensions environment variables.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app execute',
-  description: `Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.
-
-  For operations that process large amounts of data, use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) instead.`,
+  description: `The following flags are available for the \`app execute\` command:`,
   overviewPreviewDescription: `Execute GraphQL queries and mutations.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app function build',
-  description: `Compiles the function in your current directory to WebAssembly (Wasm) for testing purposes.`,
+  description: `The following flags are available for the \`app function build\` command:`,
   overviewPreviewDescription: `Compile a function to wasm.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,15 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app function info',
-  description: `The information returned includes the following:
-
-  - The function handle
-  - The function name
-  - The function API version
-  - The targeting configuration
-  - The schema path
-  - The WASM path
-  - The function runner path`,
+  description: `The following flags are available for the \`app function info\` command:`,
   overviewPreviewDescription: `Print basic information about your function.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app function replay',
-  description: `Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).`,
+  description: `The following flags are available for the \`app function replay\` command:`,
   overviewPreviewDescription: `Replays a function run from an app log.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app function run',
-  description: `Runs the function from your current directory for [testing purposes](/docs/apps/functions/testing-and-debugging). To learn how you can monitor and debug functions when errors occur, refer to [Shopify Functions error handling](/docs/api/functions/errors).`,
+  description: `The following flags are available for the \`app function run\` command:`,
   overviewPreviewDescription: `Run a function locally for testing.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,9 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app function schema',
-  description: `Generates the latest [GraphQL schema](/docs/apps/functions/input-output#graphql-schema) for a function in your app. Run this command from the function directory.
-
-  This command uses the API type and version of your function, as defined in your extension TOML file, to generate the latest GraphQL schema. The schema is written to the \`schema.graphql\` file.`,
+  description: `The following flags are available for the \`app function schema\` command:`,
   overviewPreviewDescription: `Fetch the latest GraphQL schema for a function.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app function typegen',
-  description: `Creates GraphQL types based on your [input query](/docs/apps/functions/input-output#input) for a function. Supports JavaScript functions out of the box, or any language via the \`build.typegen_command\` configuration.`,
+  description: `The following flags are available for the \`app function typegen\` command:`,
   overviewPreviewDescription: `Generate GraphQL types for a function.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,10 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app generate extension',
-  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/build/cli-for-apps/app-structure) and the documentation for your extension.
-  `,
+  description: `The following flags are available for the \`app generate extension\` command:`,
   overviewPreviewDescription: `Generate a new app Extension.`,
   type: 'command',
   isVisualComponent: false,

docs-shopify.dev/commands/app-import-custom-data-definitions.doc.ts

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app import-custom-data-definitions',
-  description: `Import metafield and metaobject definitions from your development store. [Read more about declarative custom data definitions](/docs/apps/build/custom-data/declarative-custom-data-definitions).`,
+  description: `The following flags are available for the \`app import-custom-data-definitions\` command:`,
   overviewPreviewDescription: `Import metafield and metaobject definitions.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,8 +3,8 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app import-extensions',
-  description: `Import dashboard-managed extensions into your app.`,
-  overviewPreviewDescription: `Import dashboard-managed extensions into your app.`,
+  description: `The following flags are available for the \`app import-extensions\` command:`,
+  overviewPreviewDescription: `The following flags are available for the \`app import-extensions\` command:`,
   type: 'command',
   isVisualComponent: false,
   defaultExample: {

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

@@ -3,12 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app info',
-  description: `The information returned includes the following:
-
-  - The app and dev store that's used when you run the [dev](/docs/api/shopify-cli/app/app-dev) command. You can reset these configurations using [\`dev --reset\`](/docs/api/shopify-cli/app/app-dev#flags-propertydetail-reset).
-  - The [structure](/docs/apps/tools/cli/structure) of your app project.
-  - The [access scopes](/docs/api/usage) your app has requested.
-  - System information, including the package manager and version of Shopify CLI used in the project.`,
+  description: `The following flags are available for the \`app info\` command:`,
   overviewPreviewDescription: `Print basic information about your app and extensions.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app init',
-  description: `Create a new app project`,
+  description: `The following flags are available for the \`app init\` command:`,
   overviewPreviewDescription: `Create a new app project`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app logs sources',
-  description: `The output source names can be used with the \`--source\` argument of \`shopify app logs\` to filter log output. Currently only function extensions are supported as sources.`,
+  description: `The following flags are available for the \`app logs sources\` command:`,
   overviewPreviewDescription: `Print out a list of sources that may be used with the logs command.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,14 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app logs',
-  description: `
-  Opens a real-time stream of detailed app logs from the selected app and store.
-  Use the \`--source\` argument to limit output to a particular log source, such as a specific Shopify Function handle. Use the \`shopify app logs sources\` command to view a list of sources.
-  Use the \`--status\` argument to filter on status, either \`success\` or \`failure\`.
-  \`\`\`
-  shopify app logs --status=success --source=extension.discount-function
-  \`\`\`
-  `,
+  description: `The following flags are available for the \`app logs\` command:`,
   overviewPreviewDescription: `Stream detailed logs for your Shopify app.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app release',
-  description: `Releases an existing app version. Pass the name of the version that you want to release using the \`--version\` flag.`,
+  description: `The following flags are available for the \`app release\` command:`,
   overviewPreviewDescription: `Release an app version.`,
   type: 'command',
   isVisualComponent: false,

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

@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'app versions list',
-  description: `Lists the deployed app versions. An app version is a snapshot of your app extensions.`,
+  description: `The following flags are available for the \`app versions list\` command:`,
   overviewPreviewDescription: `List deployed versions of your app.`,
   type: 'command',
   isVisualComponent: false,