ci(docs): auto-publish TypeDoc API reference to gh-pages

.github/workflows/typedoc.yml

@@ -9,21 +9,32 @@ jobs:
     name: Generate & publish API docs
     runs-on: ubuntu-latest
     permissions:
-      # peaceiris/actions-gh-pages pushes to the gh-pages branch, which needs
-      # write access to repo contents. The default GITHUB_TOKEN is read-only.
+      # peaceiris/actions-gh-pages needs write access to push to the gh-pages branch.
       contents: write
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: npm
-      - run: npm ci || npm install
-      - run: npx prisma generate
-      - run: npm run docs:openapi
-      - run: npx typedoc
+
+      # Install deps (Prisma client is a peer of typedoc-plugin-* if ever added)
+      - name: Install dependencies
+        run: npm ci
+
+      # Prisma generate is required so TypeDoc can resolve @prisma/client types
+      # when it processes db.ts and other modules that import from it.
+      - name: Generate Prisma client
+        run: npx prisma generate
+
+      - name: Build TypeDoc HTML
+        run: npx typedoc
+
       - name: Deploy to gh-pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs
+          # Overwrite only the docs output; keep any other files already on the branch.
+          keep_files: true

typedoc.json

@@ -1,4 +1,5 @@
 {
+  "name": "Wraith — API Reference",
   "entryPoints": [
     "src/index.ts",
     "src/api.ts",
@@ -9,6 +10,7 @@
     "src/events.ts",
     "src/indexer.ts"
   ],
+  "entryPointStrategy": "resolve",
   "out": "docs",
   "theme": "default",
   "readme": "README.md",
@@ -18,5 +20,8 @@
   "excludeExternals": true,
   "hideGenerator": false,
   "sort": "source-order",
-  "searchInComments": true
+  "searchInComments": true,
+  "navigationLinks": {
+    "GitHub": "https://github.com/Miracle656/wraith"
+  }
 }