feat(other): typedoc

.eslintignore

@@ -1,3 +1,4 @@
 node_modules/
 dist/
-examples/
+examples/
+docs/

.github/workflows/deploy.docs.yml

@@ -0,0 +1,56 @@
+name: deploy:docs
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  # Build job
+  build:
+    # Specify runner +  build & upload the static files as an artifact
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.1.7
+      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.0.3
+        with:
+          node-version-file: './.tool-versions'
+      - name: Install Dependencies & Build Library
+        run: |
+          npm install
+          npm run build
+          npm link
+        working-directory: ./
+
+      - name: Build static files
+        id: build
+        run: npm install && npm run docs:generate
+        working-directory: ./
+
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3.0.1
+        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.0.5

.github/workflows/test.docs.yml

@@ -0,0 +1,47 @@
+name: test:docs
+
+on: push
+
+jobs:
+  files-changed:
+    name: Detect File Changes - docs
+    runs-on: ubuntu-latest
+    outputs:
+      docs: ${{ steps.filter.outputs.docs }}
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.1.7
+      - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        id: filter
+        with:
+          filters: |
+            docs:
+              - '.github/workflows/**/*'
+              - '**/*'
+
+#  build:
+#    if: needs.files-changed.outputs.frontend == 'true'
+#    name: Build - Frontend
+#    needs: files-changed
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.1.7
+#      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.0.3
+#        with:
+#          node-version-file: './.tool-versions'
+#      - name: Frontend | Build
+#        run: npm install && npm run build
+#        working-directory: ./frontend
+
+  docs:
+    if: needs.files-changed.outputs.docs == 'true'
+    name: Docs
+    needs: files-changed
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.1.7
+      - uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.0.3
+        with:
+          node-version-file: './.tool-versions'
+      - name: Docs
+        run: npm install && npm run docs:generate
+        working-directory: ./

.gitignore

@@ -88,4 +88,7 @@ lerna-debug.log
 
 # System Files
 .DS_Store
-Thumbs.db
+Thumbs.db
+
+# docs
+/docs