Install typedoc just-in-time for API docs (end Dependabot churn, keep the docs)

.github/workflows/pages.yml

@@ -38,6 +38,13 @@ jobs:
         uses: ./.github/actions/setup-cli-deps
         with:
           node-version: "22"
+      # typedoc is needed only to generate the cli-kit API docs published to
+      # GitHub Pages. It's installed here just-in-time rather than tracked as a
+      # cli-kit devDependency so it doesn't generate Dependabot churn. Left
+      # unpinned so docs track the latest typedoc (and stay compatible with the
+      # repo's TypeScript) automatically; nothing here is committed.
+      - name: Install typedoc (docs generation only)
+        run: pnpm --filter @shopify/cli-kit add --save-dev typedoc
       - name: Build TSDoc docs
         run: pnpm build-api-docs --output-style=stream
       - name: Build Markdown files into HTML

docs/README.md

@@ -26,6 +26,7 @@ The list below contains valuable resources for people interested in contributing
 
 The [`@shopify/cli-kit`](https://www.npmjs.com/package/@shopify/cli-kit) NPM package provides utilities to abstract away interactions with the Shopify platform (e.g., authentication, API requests) and ensures experiences are consistent across the board. If you are creating a new plugin or contributing to an existing one, we recommend checking out the following resources:
 
+- [API reference](https://shopify.github.io/cli/api/cli-kit/)
 - [Creating a new command or flag](cli-kit/command-guidelines.md)
 - [Content and UI guidelines](cli-kit/ui-kit/guidelines.md)
 - [Using UI Kit](cli-kit/ui-kit/readme.md)

package.json

@@ -308,11 +308,9 @@
           "**/graphql/**/generated/*.ts"
         ],
         "project": "**/*.{ts,tsx}!",
-        "ignoreBinaries": [
-          "open"
-        ],
         "ignoreDependencies": [
-          "@graphql-typed-document-node/core"
+          "@graphql-typed-document-node/core",
+          "typedoc"
         ],
         "vite": {
           "config": [

packages/cli-kit/package.json

@@ -52,7 +52,6 @@
     "build": "nx build",
     "clean": "nx clean",
     "build-api-docs": "nx build-api-docs",
-    "open-api-docs": "nx open-api-docs",
     "lint": "nx lint",
     "lint:fix": "nx lint:fix",
     "prepack": "NODE_ENV=production pnpm nx build && cp ../../README.md README.md",
@@ -170,8 +169,7 @@
     "@vitest/coverage-istanbul": "^3.1.4",
     "msw": "^2.7.1",
     "node-stream-zip": "^1.15.0",
-    "ts-morph": "^17.0.1",
-    "typedoc": "^0.28.17"
+    "ts-morph": "^17.0.1"
   },
   "engines": {
     "node": ">=22.12.0"

packages/cli-kit/project.json

@@ -52,16 +52,6 @@
         "cwd": "packages/cli-kit"
       }
     },
-    "open-api-docs": {
-      "executor": "nx:run-commands",
-      "dependsOn": [
-        "build-api-docs"
-      ],
-      "options": {
-        "command": "open ../../docs/api/cli-kit/index.html",
-        "cwd": "packages/cli-kit"
-      }
-    },
     "lint": {
       "executor": "nx:run-commands",
       "options": {