Added client docs

.github/workflows/docs.yaml

@@ -0,0 +1,37 @@
+---
+name: Docs Preview
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write # to push to gh-pages branch
+
+concurrency:
+  group: gh-pages-write
+  cancel-in-progress: false
+
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
+      - run: pnpm install
+      - run: pnpm run docs
+
+      - name: Deploy preview to gh-pages /preview
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+          destination_dir: preview
+          commit_message: "Deploy preview from ${{ github.sha }}"

.github/workflows/main.yaml

@@ -20,3 +20,4 @@ jobs:
       - run: pnpm format
       - run: pnpm build
       - run: pnpm test
+      - run: pnpm run docs

.github/workflows/release.yaml

@@ -7,7 +7,12 @@ on:
       - "*"
 
 permissions:
-  id-token: write
+  contents: write # to push to gh-pages branch
+  id-token: write # to authenticate with OIDC when publishing to npm
+
+concurrency:
+  group: gh-pages-write
+  cancel-in-progress: false
 
 jobs:
   publish:
@@ -23,3 +28,12 @@ jobs:
           version: 10
       - run: pnpm install
       - run: pnpm publish --no-git-checks
+      - run: pnpm run docs
+
+      - name: Deploy released docs to gh-pages root
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+          keep_files: true
+          commit_message: "Deploy released docs ${{ github.ref_name }}"

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
+docs
 .npmrc

package.json

@@ -12,6 +12,7 @@
     "format": "prettier --check .",
     "build": "tsc",
     "test": "jest",
+    "docs": "typedoc --plugin typedoc-plugin-extras --out docs/ src/index.ts",
     "prepack": "pnpm build"
   },
   "repository": {
@@ -37,6 +38,8 @@
     "jest": "^30.0.4",
     "prettier": "^3.6.2",
     "ts-jest": "^29.4.0",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-extras": "^4.0.1",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.32.1"
   }