Add documentation deployment workflow

.github/workflows/pages.yml

@@ -0,0 +1,31 @@
+name: Deploy the document to Pages
+on:
+  push:
+    branches: ['main']
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npx typedoc
+      - uses: actions/configure-pages@v4
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs'
+      - uses: actions/deploy-pages@v4

.gitignore

@@ -1 +1,2 @@
 node_modules
+docs

package.json

@@ -7,6 +7,7 @@
     "@aws-sdk/util-dynamodb": "^3.564.0",
     "@types/node": "^20.12.7",
     "dataloader": "^2.2.2",
+    "typedoc": "^0.25.13",
     "typescript": "^5.4.5",
     "ulid": "^2.3.0"
   }