update generate docs to v1.1.1 by laurelthorburn · Pull Request #7189 · Shopify/cli

laurelthorburn · 2026-04-03T16:39:00Z

Add @publicdocs tags and upgrade @shopify/generate-docs to v1.1.1 for v2 doc pipeline

🎟️ Part of https://github.com/shop/issues-learn/issues/1466

🎩 Tpp hatting portion of PR in shopify-dev: https://github.com/shop/world/pull/577553

I've migrated 90% of our gen docs now, and y'all do it... uhm different than the rest lol. If you don't like how I modified your docs, we can merge this and then your team can decide how you want things to change. Just let me get this migration done and then it's yours to change as you want (within reason)>

We are actively working on our internal docs, but Shopify has decided to lay off our valuable content writers who support the creation of these so... one day.

Summary

Upgrade @shopify/generate-docs from 0.15.6 to 1.1.1 to enable v2 documentation pipeline
Add @publicdocs JSDoc tags to all autogenerated command flag interfaces via the generate.ts template
Add docs-shopify.dev/type-descriptions.json as source of truth for type descriptions, ensuring v1 and v2 output match
exactly (77/79 exact, 2 whitespace-only diffs from v2 JSDoc parser)
Update bin/docs/build-dev-docs.sh to copy all generated files (generated_docs_data.json, generated_docs_data_v2.json,
generated_static_pages.json, generated_category_pages.json) to the shopify-dev world repo
Update bin/create-doc-pr.js to include generated_docs_data_v2.json in shopify-dev PRs
Update unit tests for new readFile dependency and @publicdocs JSDoc output

How it works

 Source of truth: docs-shopify.dev/type-descriptions.json — a JSON file mapping each interface name (e.g. appbuild) to its canonical description text. This was extracted from the v1 generated docs.
                                                                                                                        
Both writeCommandDocumentation (v1 .doc.ts pipeline) and writeCommandFlagInterface (v2 @publicDocs pipeline) read descriptions from this same JSON file, so they produce matching output.
                                                                                                                        
 type-descriptions.json                                               
         │
         ├──> writeCommandDocumentation() ──> .doc.ts files ──> generate-docs v1 ──> generated_docs_data.json
         │                                                                                                              
         └──> writeCommandFlagInterface() ──> .interface.ts files (with @publicDocs JSDoc)
                                                     │                                                                  
                                                     └──> generate-docs v2 ──> generated_docs_data_v2.json

Changes to generate.ts

writeCommandDocumentation — generates .doc.ts files for the v1 pipeline
- Before: description came from command.descriptionWithMarkdown ?? command.description ?? command.summary (oclif
command object)
- Now: reads type-descriptions.json first, uses that as primary source, falls back to oclif command if the type isn't
in the JSON
writeCommandFlagInterface — generates .interface.ts files for the v2 pipeline
- Before: no JSDoc, no description, no @publicdocs tag
- Now: reads the same type-descriptions.json, formats the description as a JSDoc comment, and adds @publicdocs
- This is what generate-docs v2 scans to produce generated_docs_data_v2.json

Test plan

Run pnpm build-dev-docs and verify generated_docs_data_v2.json is created alongside existing files
Verify all 79 definition descriptions in v2 match v1 exactly
Verify 8 flagless commands (auth logout, config autocorrect off/on/status, hydrogen shortcut, search, upgrade,
version) have empty interfaces with @publicdocs in v2
Verify existing generated_docs_data.json (v1) output is unchanged in structure
Verify docs render correctly in shopify-dev preview
Unit tests pass: npx vitest run packages/cli/src/cli/commands/docs/generate.test.ts

…place as doc ts is going away

packages/cli/src/cli/commands/docs/generate.ts

github-actions · 2026-04-03T19:49:05Z

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

Copilot

Pull request overview

Updates the CLI documentation generation tooling to support the v2 docs pipeline by upgrading @shopify/generate-docs, emitting @publicDocs JSDoc on generated flag interfaces, and aligning command/interface descriptions via a shared type-descriptions.json source of truth.

Changes:

Upgrade @shopify/generate-docs from 0.15.6 to 1.1.1 (and update lockfile).
Update the docs generator (generate.ts) to read docs-shopify.dev/type-descriptions.json and to add @publicDocs JSDoc to generated *.interface.ts files.
Regenerate command *.doc.ts templates and command flag interface files, and update scripts to include/copy generated_docs_data_v2.json.

Reviewed changes

Copilot reviewed 170 out of 175 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`package.json`	Bumps `@shopify/generate-docs` dependency to `1.1.1`.
`pnpm-lock.yaml`	Lockfile update reflecting the `@shopify/generate-docs@1.1.1` upgrade.
`packages/cli/src/cli/commands/docs/generate.ts`	Reads `type-descriptions.json` for descriptions; emits `@publicDocs` JSDoc on generated flag interfaces.
`packages/cli/src/cli/commands/docs/generate.test.ts`	Updates unit tests/mocks for the new `readFile` dependency and new generated output.
`docs-shopify.dev/type-descriptions.json`	Adds canonical per-interface description strings used to align v1/v2 outputs.
`bin/docs/build-dev-docs.sh`	Copies the new `generated_docs_data_v2.json` (and other generated artifacts) to the `world` repo path when present.
`bin/create-doc-pr.js`	Includes `generated_docs_data_v2.json` when creating PRs for `shopify-dev` docs updates.
`docs-shopify.dev/commands/app-build.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-bulk-cancel.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-bulk-execute.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-bulk-status.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-config-link.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-config-pull.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-config-use.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-config-validate.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-deploy.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-dev-clean.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-dev.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-env-pull.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-env-show.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-execute.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-function-build.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-function-info.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-function-replay.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-function-run.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-function-schema.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-function-typegen.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-generate-extension.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-import-custom-data-definitions.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-import-extensions.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-info.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-init.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-logs-sources.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-logs.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-release.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-versions-list.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/app-webhook-trigger.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/auth-login.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/commands.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/help.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-build.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-check.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-codegen.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-customer-account-push.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-debug-cpu.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-deploy.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-dev.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-env-list.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-env-pull.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-env-push.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-generate-route.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-generate-routes.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-init.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-link.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-list.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-login.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-logout.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-preview.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-setup-css.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-setup-markets.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-setup-vite.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-setup.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-unlink.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/hydrogen-upgrade.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/organization-list.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/store-auth.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/store-execute.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-check.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-console.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-delete.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-dev.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-duplicate.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-info.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-init.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-language-server.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-list.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-metafields-pull.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-open.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-package.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-preview.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-profile.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-publish.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-pull.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-push.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-rename.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/theme-share.doc.ts`	Regenerated command doc template using the new description source-of-truth.
`docs-shopify.dev/commands/interfaces/app-build.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-bulk-cancel.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-config-link.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-config-pull.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-config-use.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-config-validate.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-deploy.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-dev-clean.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-dev.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-env-pull.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-env-show.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-execute.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-function-build.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-function-info.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-function-replay.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-function-run.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-function-schema.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-function-typegen.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-generate-extension.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-import-custom-data-definitions.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-import-extensions.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-info.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-init.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-logs-sources.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-logs.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-release.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-versions-list.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/app-webhook-trigger.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/auth-login.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/auth-logout.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).
`docs-shopify.dev/commands/interfaces/commands.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/config-autocorrect-off.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).
`docs-shopify.dev/commands/interfaces/config-autocorrect-on.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).
`docs-shopify.dev/commands/interfaces/config-autocorrect-status.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).
`docs-shopify.dev/commands/interfaces/help.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-build.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-check.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-codegen.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-customer-account-push.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-debug-cpu.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-deploy.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-dev.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-env-list.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-env-pull.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-env-push.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-generate-route.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-generate-routes.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-init.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-link.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-list.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-login.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-logout.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-preview.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-shortcut.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).
`docs-shopify.dev/commands/interfaces/hydrogen-setup-css.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-setup-markets.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-setup-vite.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-setup.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-unlink.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/hydrogen-upgrade.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/organization-list.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/search.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).
`docs-shopify.dev/commands/interfaces/store-auth.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/store-execute.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-check.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-console.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-delete.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-dev.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-duplicate.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-info.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-init.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-language-server.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-list.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-metafields-pull.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-open.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-package.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-preview.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-profile.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-publish.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-pull.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-push.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-rename.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/theme-share.interface.ts`	Regenerated flags interface with `@publicDocs` JSDoc.
`docs-shopify.dev/commands/interfaces/upgrade.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).
`docs-shopify.dev/commands/interfaces/version.interface.ts`	Regenerated empty flags interface with `@publicDocs` JSDoc (no description text).

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/cli/src/cli/commands/docs/generate.ts

packages/cli/src/cli/commands/docs/generate.test.ts

dmerand

I'm not an expert in this pipeline but my robots found something worth 👀 and I've vetted that.

dmerand · 2026-04-03T21:02:35Z

packages/cli/src/cli/commands/docs/generate.ts

+  const description =
+    typeDescriptions[interfaceName] ?? command.descriptionWithMarkdown ?? command.description ?? command.summary ?? ''
+  const cleanDescription = description.replace(/\\/g, '\\\\').replace(/`/g, '\\`')
  const previewDescription = command.summary ?? description ?? ''


🐛 Bug: type-descriptions.json contains flag-section boilerplate ("The following flags are available for...") which is correct for the v2 interface JSDoc, but wrong for the v1 command-page overview. This replaces substantive command descriptions with generic text.

Suggestion: Revert writeCommandDocumentation to use the oclif command metadata (the original fallback chain):

const description = command.descriptionWithMarkdown ?? command.description ?? command.summary ?? ''

Keep writeCommandFlagInterface reading from type-descriptions.json — that's the right source for interface-level JSDoc. The two pipelines describe different things (command overview vs. flag-section intro), so they shouldn't share a source. The escape-character fixes around this line are independent improvements and can stay.

idk, i'll leave to you all to play with/decide what you want to do . My goal is get the docs and get them to match prod.. then i leave 👻 . This repo was the most complicated to move due to the way y'all have the .ts files override each time so getting the js doc comments in place was fun... ish

@dmerand I tried this and it broke all the descriptions :eek:

The ai mastermind says to tell you the following:

The type-descriptions.json text ("The following flags are available for the app build command:") is intentionally used as the description in both the .doc.ts command pages and the interface JSDoc. This is what matches production today. The oclif command metadata (e.g. "This command executes the build script...") is available as a fallback if a type description is missing, but the type-descriptions source is the primary one for both pipelines. Reverting to oclif-only descriptions in writeCommandDocumentation causes all ~80 .doc.ts files to regenerate with different descriptions that don't match prod. I tested the revert and confirmed it breaks the current output, so I've kept the existing behavior.

I am too lazy to fix the botched spacing

laurelthorburn added 4 commits April 3, 2026 10:38

update generate docs to v1.1.1

d358c3d

modify script to copy data to shopify dev repo

f8a5199

add public docs to generate file

e5bd8d4

initial build of auto docs while trying to get their descriptions in …

fee2a05

…place as doc ts is going away

github-advanced-security bot found potential problems Apr 3, 2026

View reviewed changes

packages/cli/src/cli/commands/docs/generate.ts Fixed Show fixed Hide fixed

attempt to keep descriptions while docs are auto generated

e0a5145

github-advanced-security bot found potential problems Apr 3, 2026

View reviewed changes

packages/cli/src/cli/commands/docs/generate.ts Fixed Show fixed Hide fixed

laurelthorburn added 4 commits April 3, 2026 11:26

correct the type descriptions

c41c024

ci linter

17402a2

ci check failures

408a503

type check fix

51e7399

laurelthorburn marked this pull request as ready for review April 3, 2026 19:48

laurelthorburn requested review from a team as code owners April 3, 2026 19:48

Copilot AI review requested due to automatic review settings April 3, 2026 19:48

Copilot started reviewing on behalf of laurelthorburn April 3, 2026 19:49 View session

laurelthorburn requested a review from jgray7019 April 3, 2026 19:49

Copilot AI reviewed Apr 3, 2026

View reviewed changes

dmerand reviewed Apr 3, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update generate docs to v1.1.1#7189

update generate docs to v1.1.1#7189
laurelthorburn wants to merge 9 commits intomainfrom
migrate-cli-to-gen-docs-v1

laurelthorburn commented Apr 3, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmerand left a comment

Uh oh!

dmerand Apr 3, 2026

Uh oh!

laurelthorburn Apr 3, 2026

Uh oh!

laurelthorburn Apr 4, 2026

Uh oh!

laurelthorburn Apr 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

laurelthorburn commented Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmerand left a comment

Choose a reason for hiding this comment

Uh oh!

dmerand Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

laurelthorburn Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

laurelthorburn Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

laurelthorburn Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

laurelthorburn commented Apr 3, 2026 •

edited

Loading