Skip to content

Commit 3efe630

Browse files
Merge pull request #7189 from Shopify/migrate-cli-to-gen-docs-v1
update generate docs to v1.1.1
2 parents 0146752 + 9a6db95 commit 3efe630

95 files changed

Lines changed: 6957 additions & 340 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

bin/create-doc-pr.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ async function createPR() {
1515

1616
const generatedDirectory = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "../docs-shopify.dev/generated")
1717

18-
const fileNames = ['generated_category_pages.json', 'generated_docs_data.json', 'generated_static_pages.json']
18+
const fileNames = ['generated_category_pages.json', 'generated_docs_data.json', 'generated_docs_data_v2.json', 'generated_static_pages.json']
1919

2020
const files = {}
2121
for (const fileName of fileNames) {

bin/docs/build-dev-docs.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,14 @@ eval $COMPILE_DOCS
1515
eval $COMPILE_STATIC_PAGES
1616
eval $COMPILE_CATEGORY_PAGES
1717
echo "DONE"
18+
19+
# Copy generated docs to shopify-dev in the world repo if available
20+
WORLD_DEST="$HOME/world/trees/root/src/areas/platforms/shopify-dev/db/data/docs/templated_apis/shopify_cli"
21+
if [ -d "$WORLD_DEST" ]; then
22+
for file in generated_docs_data.json generated_docs_data_v2.json generated_static_pages.json generated_category_pages.json; do
23+
if [ -f "./docs-shopify.dev/generated/$file" ]; then
24+
cp "./docs-shopify.dev/generated/$file" "$WORLD_DEST/$file"
25+
echo "Copied $file to $WORLD_DEST"
26+
fi
27+
done
28+
fi

docs-shopify.dev/commands/interfaces/app-build.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app build` command:
4+
* @publicDocs
5+
*/
26
export interface appbuild {
37
/**
48
* The Client ID of your app.

docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app bulk cancel` command:
4+
* @publicDocs
5+
*/
26
export interface appbulkcancel {
37
/**
48
* The Client ID of your app.

docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app bulk execute` command:
4+
* @publicDocs
5+
*/
26
export interface appbulkexecute {
37
/**
48
* The Client ID of your app.

docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app bulk status` command:
4+
* @publicDocs
5+
*/
26
export interface appbulkstatus {
37
/**
48
* The Client ID of your app.

docs-shopify.dev/commands/interfaces/app-config-link.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app config link` command:
4+
* @publicDocs
5+
*/
26
export interface appconfiglink {
37
/**
48
* The Client ID of your app.

docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app config pull` command:
4+
* @publicDocs
5+
*/
26
export interface appconfigpull {
37
/**
48
* The Client ID of your app.

docs-shopify.dev/commands/interfaces/app-config-use.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app config use` command:
4+
* @publicDocs
5+
*/
26
export interface appconfiguse {
37
/**
48
* The Client ID of your app.

docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// This is an autogenerated file. Don't edit this file manually.
2+
/**
3+
* The following flags are available for the `app config validate` command:
4+
* @publicDocs
5+
*/
26
export interface appconfigvalidate {
37
/**
48
* The Client ID of your app.

0 commit comments

Comments
 (0)