Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion bin/create-doc-pr.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
11 changes: 11 additions & 0 deletions bin/docs/build-dev-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions docs-shopify.dev/commands/interfaces/app-build.interface.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app build` command:
* @publicDocs
*/
export interface appbuild {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app bulk cancel` command:
* @publicDocs
*/
export interface appbulkcancel {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app bulk execute` command:
* @publicDocs
*/
export interface appbulkexecute {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app bulk status` command:
* @publicDocs
*/
export interface appbulkstatus {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app config link` command:
* @publicDocs
*/
export interface appconfiglink {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app config pull` command:
* @publicDocs
*/
export interface appconfigpull {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app config use` command:
* @publicDocs
*/
export interface appconfiguse {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app config validate` command:
* @publicDocs
*/
export interface appconfigvalidate {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app deploy` command:
* @publicDocs
*/
export interface appdeploy {
/**
* Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app dev clean` command:
* @publicDocs
*/
export interface appdevclean {
/**
* The Client ID of your app.
Expand Down
4 changes: 4 additions & 0 deletions docs-shopify.dev/commands/interfaces/app-dev.interface.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app dev` command:
* @publicDocs
*/
export interface appdev {
/**
* Resource URL for checkout UI extension. Format: "/cart/{productVariantID}:{productQuantity}"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app env pull` command:
* @publicDocs
*/
export interface appenvpull {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app env show` command:
* @publicDocs
*/
export interface appenvshow {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app execute` command:
* @publicDocs
*/
export interface appexecute {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app function build` command:
* @publicDocs
*/
export interface appfunctionbuild {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app function info` command:
* @publicDocs
*/
export interface appfunctioninfo {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app function replay` command:
* @publicDocs
*/
export interface appfunctionreplay {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app function run` command:
* @publicDocs
*/
export interface appfunctionrun {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app function schema` command:
* @publicDocs
*/
export interface appfunctionschema {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app function typegen` command:
* @publicDocs
*/
export interface appfunctiontypegen {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app generate extension` command:
* @publicDocs
*/
export interface appgenerateextension {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app import-custom-data-definitions` command:
* @publicDocs
*/
export interface appimportcustomdatadefinitions {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app import-extensions` command:
* @publicDocs
*/
export interface appimportextensions {
/**
* The Client ID of your app.
Expand Down
4 changes: 4 additions & 0 deletions docs-shopify.dev/commands/interfaces/app-info.interface.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app info` command:
* @publicDocs
*/
export interface appinfo {
/**
* The Client ID of your app.
Expand Down
4 changes: 4 additions & 0 deletions docs-shopify.dev/commands/interfaces/app-init.interface.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app init` command:
* @publicDocs
*/
export interface appinit {
/**
* The Client ID of your app. Use this to automatically link your new project to an existing app. Using this flag avoids the app selection prompt.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app logs sources` command:
* @publicDocs
*/
export interface applogssources {
/**
* The Client ID of your app.
Expand Down
4 changes: 4 additions & 0 deletions docs-shopify.dev/commands/interfaces/app-logs.interface.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app logs` command:
* @publicDocs
*/
export interface applogs {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app release` command:
* @publicDocs
*/
export interface apprelease {
/**
* Allows removing extensions and configuration without requiring user confirmation. For CI/CD environments, the recommended flag is --allow-updates.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app versions list` command:
* @publicDocs
*/
export interface appversionslist {
/**
* The Client ID of your app.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `app webhook trigger` command:
* @publicDocs
*/
export interface appwebhooktrigger {
/**
* The URL where the webhook payload should be sent.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `auth login` command:
* @publicDocs
*/
export interface authlogin {
/**
* Alias of the session you want to login to.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `auth logout` command:
* @publicDocs
*/
export interface authlogout {

}
4 changes: 4 additions & 0 deletions docs-shopify.dev/commands/interfaces/commands.interface.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `commands` command:
* @publicDocs
*/
export interface commands {
/**
* Only show provided columns (comma-separated).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `config autocorrect off` command:
* @publicDocs
*/
export interface configautocorrectoff {

}
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `config autocorrect on` command:
* @publicDocs
*/
export interface configautocorrecton {

}
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `config autocorrect status` command:
* @publicDocs
*/
export interface configautocorrectstatus {

}
4 changes: 4 additions & 0 deletions docs-shopify.dev/commands/interfaces/help.interface.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `help` command:
* @publicDocs
*/
export interface help {
/**
* Include all nested commands in the output.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `hydrogen build` command:
* @publicDocs
*/
export interface hydrogenbuild {
/**
* Show a bundle size summary after building. Defaults to true, use `--no-bundle-stats` to disable.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `hydrogen check` command:
* @publicDocs
*/
export interface hydrogencheck {
/**
* The path to the directory of the Hydrogen storefront. Defaults to the current directory where the command is run.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `hydrogen codegen` command:
* @publicDocs
*/
export interface hydrogencodegen {
/**
* Specify a path to a codegen configuration file. Defaults to `<root>/codegen.ts` if it exists.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// This is an autogenerated file. Don't edit this file manually.
/**
* The following flags are available for the `hydrogen customer-account-push` command:
* @publicDocs
*/
export interface hydrogencustomeraccountpush {
/**
* The development domain of your application.
Expand Down
Loading
Loading