chore(github-ci): setup deploy docs on github pages

.github/workflows/docs.yaml

@@ -0,0 +1,50 @@
+name: Build and Deploy Docs
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - run: |
+          npm ci
+          npm run -w libs/protocol docs
+          mkdir docs
+          mv libs/protocol/docs docs/protocol
+
+      - name: Fix permissions
+        run: |
+          chmod -c -R +rX "docs/" | while read line; do
+            echo "::warning title=Invalid file permissions automatically fixed::$line"
+          done
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+  # Deploy job
+  deploy:
+    # Add a dependency to the build job
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

.gitignore

@@ -1,3 +1,4 @@
 dist
 node_modules
-.env
+.env
+docs/

libs/protocol/package.json

@@ -11,6 +11,7 @@
   "license": "MIT",
   "scripts": {
     "build": "tsc",
+    "docs": "typedoc",
     "prepack": "npm run build"
   },
   "types": "src/index.ts",

libs/protocol/typedoc.json

@@ -0,0 +1 @@
+../../typedoc.json

package.json

@@ -34,6 +34,7 @@
   "devDependencies": {
     "@tsconfig/node-lts": "^20.1.0",
     "ts-node": "^10.9.2",
+    "typedoc": "^0.25.12",
     "typescript": "^5.3.3"
   },
   "dependencies": {

typedoc.json

@@ -0,0 +1,7 @@
+{
+  // Comments are supported, like tsconfig.json
+  "entryPoints": [
+    "src/index.ts"
+  ],
+  "out": "docs"
+}