build: write all docs for workspace packages (#2533)

zimeg · web-flow · commit 9b2341422af5 · 2026-03-12T16:33:26.000-07:00
diff --git a/.claude/settings.json b/.claude/settings.json
@@ -30,6 +30,7 @@
       "Bash(npm install)",
       "Bash(npm install:*)",
       "Bash(npm run build:*)",
+      "Bash(npm run docs:*)",
       "Bash(npm run lint:*)",
       "Bash(npm run lint:fix:*)",
       "Bash(npm show:*)",
diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md
@@ -77,7 +77,13 @@ Remove cached project dependencies with `rm -r node_modules package-lock.json` b
 
 The reference docs for each package is independent of the others. They're generated using the `typedoc` and `typedoc-plugin-markdown` packages with the configurations of the package's `typedoc.json` file.
 
-Each package has a script to these generate reference docs. For example:
+Generate reference docs for all packages:
+
+```sh
+npm run docs
+```
+
+Or generate docs for a specific package. For example:
 
 ```sh
 npm run docs --workspace packages/web-api
diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml
@@ -61,6 +61,8 @@ jobs:
           npm run build --workspace=@slack/socket-mode
       - name: Lint
         run: npm run lint
+      - name: Build docs
+        run: npm run docs
       - name: Run tests (Node 18/20)
         if: matrix.node-version != '22.x'
         shell: bash
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
   ],
   "scripts": {
     "changeset": "npx @changesets/cli",
+    "docs": "npm run docs --workspaces --if-present",
     "lint": "npx @biomejs/biome check packages",
     "lint:fix": "npx @biomejs/biome check --write packages",
     "test": "npm test --workspaces --if-present"
@@ -30,6 +31,8 @@
     "@types/node": "^18.19.130",
     "shx": "^0.4.0",
     "tsx": "^4.20.6",
+    "typedoc": "^0.28.7",
+    "typedoc-plugin-markdown": "^4.7.1",
     "typescript": "5.9.3"
   }
 }
diff --git a/packages/cli-test/package.json b/packages/cli-test/package.json
@@ -43,8 +43,6 @@
   "devDependencies": {
     "@types/sinon": "^21.0.0",
     "cross-env": "^10.0.0",
-    "sinon": "^21.0.0",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1"
+    "sinon": "^21.0.0"
   }
 }
diff --git a/packages/logger/package.json b/packages/logger/package.json
@@ -39,9 +39,5 @@
   },
   "dependencies": {
     "@types/node": ">=18"
-  },
-  "devDependencies": {
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1"
   }
 }
diff --git a/packages/oauth/package.json b/packages/oauth/package.json
@@ -50,8 +50,6 @@
   "devDependencies": {
     "@types/sinon": "^21",
     "rewiremock": "^3",
-    "sinon": "^21",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.0"
+    "sinon": "^21"
   }
 }
diff --git a/packages/rtm-api/package.json b/packages/rtm-api/package.json
@@ -57,8 +57,6 @@
   "devDependencies": {
     "@types/sinon": "^17",
     "@types/ws": "^8",
-    "sinon": "^21",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1"
+    "sinon": "^21"
   }
 }
diff --git a/packages/socket-mode/package.json b/packages/socket-mode/package.json
@@ -62,8 +62,6 @@
     "@types/sinon": "^21",
     "nodemon": "^3.1.0",
     "proxyquire": "^2.1.3",
-    "sinon": "^21",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.0"
+    "sinon": "^21"
   }
 }
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -39,9 +39,7 @@
     "test:types": "tsd"
   },
   "devDependencies": {
-    "tsd": "^0.33.0",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1"
+    "tsd": "^0.33.0"
   },
   "tsd": {
     "directory": "test"
diff --git a/packages/web-api/package.json b/packages/web-api/package.json
@@ -68,9 +68,7 @@
     "busboy": "^1",
     "nock": "^14",
     "sinon": "^21",
-    "tsd": "^0.33.0",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1"
+    "tsd": "^0.33.0"
   },
   "tsd": {
     "directory": "test/types"
diff --git a/packages/webhook/package.json b/packages/webhook/package.json
@@ -47,8 +47,6 @@
     "axios": "^1.13.5"
   },
   "devDependencies": {
-    "nock": "^14.0.6",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1"
+    "nock": "^14.0.6"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,6 @@`
`43`	`43`	`"devDependencies": {`
`44`	`44`	`"@types/sinon": "^21.0.0",`
`45`	`45`	`"cross-env": "^10.0.0",`
`46`		`- "sinon": "^21.0.0",`
`47`		`- "typedoc": "^0.28.7",`
`48`		`- "typedoc-plugin-markdown": "^4.7.1"`
	`46`	`+ "sinon": "^21.0.0"`
`49`	`47`	`}`
`50`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,5 @@`
`39`	`39`	`},`
`40`	`40`	`"dependencies": {`
`41`	`41`	`"@types/node": ">=18"`
`42`		`- },`
`43`		`- "devDependencies": {`
`44`		`- "typedoc": "^0.28.7",`
`45`		`- "typedoc-plugin-markdown": "^4.7.1"`
`46`	`42`	`}`
`47`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,6 @@`
`50`	`50`	`"devDependencies": {`
`51`	`51`	`"@types/sinon": "^21",`
`52`	`52`	`"rewiremock": "^3",`
`53`		`- "sinon": "^21",`
`54`		`- "typedoc": "^0.28.7",`
`55`		`- "typedoc-plugin-markdown": "^4.7.0"`
	`53`	`+ "sinon": "^21"`
`56`	`54`	`}`
`57`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,8 +57,6 @@`
`57`	`57`	`"devDependencies": {`
`58`	`58`	`"@types/sinon": "^17",`
`59`	`59`	`"@types/ws": "^8",`
`60`		`- "sinon": "^21",`
`61`		`- "typedoc": "^0.28.7",`
`62`		`- "typedoc-plugin-markdown": "^4.7.1"`
	`60`	`+ "sinon": "^21"`
`63`	`61`	`}`
`64`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,6 @@`
`62`	`62`	`"@types/sinon": "^21",`
`63`	`63`	`"nodemon": "^3.1.0",`
`64`	`64`	`"proxyquire": "^2.1.3",`
`65`		`- "sinon": "^21",`
`66`		`- "typedoc": "^0.28.7",`
`67`		`- "typedoc-plugin-markdown": "^4.7.0"`
	`65`	`+ "sinon": "^21"`
`68`	`66`	`}`
`69`	`67`	`}`