build: write all docs for workspace packages

.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:*)",
@@ -38,6 +39,7 @@
       "Bash(nvm use:*)",
       "Bash(tail:*)",
       "Bash(tree:*)",
+      "WebFetch(domain:devblogs.microsoft.com)",
       "WebFetch(domain:docs.slack.dev)",
       "WebFetch(domain:github.com)",
       "WebFetch(domain:npmjs.com)",

.github/maintainers_guide.md

@@ -55,7 +55,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

.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

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"
   }
 }

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"
   }
 }

packages/logger/package.json

@@ -36,9 +36,5 @@
     "test": "npm run test:unit",
     "test:node18": "npm run build && node --test --test-reporter=spec --import tsx --test src/index.test.ts",
     "test:unit": "npm run build && node --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout --test-reporter=lcov --test-reporter-destination=lcov.info --test-reporter=junit --test-reporter-destination=test-results.xml --import tsx --test src/index.test.ts"
-  },
-  "devDependencies": {
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.1"
   }
 }

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"
   }
 }

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"
   }
 }

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"
   }
 }

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"

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"

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"
   }
 }