Skip to content

Commit c19e476

Browse files
gonzaloriestragonzaloriestra
committed
Fix build-dev-docs and update docs
1 parent 25e9a22 commit c19e476

12 files changed

Lines changed: 230 additions & 5 deletions

‎bin/docs/build-dev-docs.sh‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
echo "STARTING"
2-
COMPILE_DOCS="pnpx tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpx generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js"
3-
COMPILE_STATIC_PAGES="pnpx tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpx generate-docs --isLandingPage --input ./docs-shopify.dev/static --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/static/*.doc.js"
4-
COMPILE_CATEGORY_PAGES="pnpx tsc docs-shopify.dev/categories/*.doc.ts --moduleResolution node --target esNext && pnpx generate-docs --isCategoryPage --input ./docs-shopify.dev/categories --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/categories/*.doc.js"
2+
COMPILE_DOCS="pnpm tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpm generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js"
3+
COMPILE_STATIC_PAGES="pnpm tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpm generate-docs --isLandingPage --input ./docs-shopify.dev/static --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/static/*.doc.js"
4+
COMPILE_CATEGORY_PAGES="pnpm tsc docs-shopify.dev/categories/*.doc.ts --moduleResolution node --target esNext && pnpm generate-docs --isCategoryPage --input ./docs-shopify.dev/categories --output ./docs-shopify.dev/generated && rm -rf docs-shopify.dev/categories/*.doc.js"
55

66
if [ "$1" = "isTest" ];
77
then
8-
COMPILE_DOCS="pnpx tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpx generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js"
9-
COMPILE_STATIC_PAGES="pnpx tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpx generate-docs --isLandingPage --input ./docs-shopify.dev/static/docs-shopify.dev --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/static/*.doc.js"
8+
COMPILE_DOCS="pnpm tsc --project bin/docs/tsconfig.docs.json --moduleResolution node --target esNext && pnpm generate-docs --overridePath ./bin/docs/typeOverride.json --input ./docs-shopify.dev/commands --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/commands/**/*.doc.js docs-shopify.dev/commands/*.doc.js"
9+
COMPILE_STATIC_PAGES="pnpm tsc docs-shopify.dev/static/*.doc.ts --moduleResolution node --target esNext && pnpm generate-docs --isLandingPage --input ./docs-shopify.dev/static/docs-shopify.dev --output ./docs-shopify.dev/static/temp && rm -rf docs-shopify.dev/static/*.doc.js"
1010
fi
1111

1212
echo $1

‎docs-shopify.dev/commands/config-autoupgrade-off.doc.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: 'config autoupgrade off',
6+
description: `Disable automatic upgrades for Shopify CLI.
7+
8+
When auto-upgrade is disabled, Shopify CLI won't automatically update. Run \`shopify upgrade\` to update manually.
9+
10+
To enable auto-upgrade, run \`shopify config autoupgrade on\`.
11+
`,
12+
overviewPreviewDescription: `Disable automatic upgrades for Shopify CLI.`,
13+
type: 'command',
14+
isVisualComponent: false,
15+
defaultExample: {
16+
codeblock: {
17+
tabs: [
18+
{
19+
title: 'config autoupgrade off',
20+
code: './examples/config-autoupgrade-off.example.sh',
21+
language: 'bash',
22+
},
23+
],
24+
title: 'config autoupgrade off',
25+
},
26+
},
27+
definitions: [
28+
],
29+
category: 'general commands',
30+
related: [
31+
],
32+
}
33+
34+
export default data

‎docs-shopify.dev/commands/config-autoupgrade-on.doc.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: 'config autoupgrade on',
6+
description: `Enable automatic upgrades for Shopify CLI.
7+
8+
When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version once per day. Major version upgrades are skipped and must be done manually.
9+
10+
To disable auto-upgrade, run \`shopify config autoupgrade off\`.
11+
`,
12+
overviewPreviewDescription: `Enable automatic upgrades for Shopify CLI.`,
13+
type: 'command',
14+
isVisualComponent: false,
15+
defaultExample: {
16+
codeblock: {
17+
tabs: [
18+
{
19+
title: 'config autoupgrade on',
20+
code: './examples/config-autoupgrade-on.example.sh',
21+
language: 'bash',
22+
},
23+
],
24+
title: 'config autoupgrade on',
25+
},
26+
},
27+
definitions: [
28+
],
29+
category: 'general commands',
30+
related: [
31+
],
32+
}
33+
34+
export default data

‎docs-shopify.dev/commands/config-autoupgrade-status.doc.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: 'config autoupgrade status',
6+
description: `Check whether auto-upgrade is enabled, disabled, or not yet configured.
7+
8+
When auto-upgrade is enabled, Shopify CLI automatically updates to the latest version after each command.
9+
10+
Run \`shopify config autoupgrade on\` or \`shopify config autoupgrade off\` to configure it.
11+
`,
12+
overviewPreviewDescription: `Check whether auto-upgrade is enabled, disabled, or not yet configured.`,
13+
type: 'command',
14+
isVisualComponent: false,
15+
defaultExample: {
16+
codeblock: {
17+
tabs: [
18+
{
19+
title: 'config autoupgrade status',
20+
code: './examples/config-autoupgrade-status.example.sh',
21+
language: 'bash',
22+
},
23+
],
24+
title: 'config autoupgrade status',
25+
},
26+
},
27+
definitions: [
28+
],
29+
category: 'general commands',
30+
related: [
31+
],
32+
}
33+
34+
export default data

‎docs-shopify.dev/commands/examples/config-autoupgrade-off.example.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shopify config autoupgrade off

‎docs-shopify.dev/commands/examples/config-autoupgrade-on.example.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shopify config autoupgrade on

‎docs-shopify.dev/commands/examples/config-autoupgrade-status.example.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shopify config autoupgrade status

‎docs-shopify.dev/commands/interfaces/config-autoupgrade-off.interface.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `config autoupgrade off` command:
4+
* @publicDocs
5+
*/
6+
export interface configautoupgradeoff {
7+
8+
}

‎docs-shopify.dev/commands/interfaces/config-autoupgrade-on.interface.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `config autoupgrade on` command:
4+
* @publicDocs
5+
*/
6+
export interface configautoupgradeon {
7+
8+
}

‎docs-shopify.dev/commands/interfaces/config-autoupgrade-status.interface.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `config autoupgrade status` command:
4+
* @publicDocs
5+
*/
6+
export interface configautoupgradestatus {
7+
8+
}

0 commit comments

Comments
 (0)