docs: added typedoc (#19)

* docs: added typedoc

* ci: update .github/workflows/typedoc.yaml

Co-authored-by: Netanel Cohen <[email protected]>

* ci: fixed nati insanely awful suggestion

---------

Co-authored-by: Netanel Cohen <[email protected]>

.github/workflows/typedoc.yaml

@@ -0,0 +1,50 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy typedoc to Pages
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ['master']
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  actions: read
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: 'github-pages'
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - name: Install TS Project dependencies
+        run: npm ci
+      - name: build the package
+        run: npm run build
+      - name: build docs
+        run: npm run docs
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload docs directory
+          path: './docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -105,3 +105,5 @@ dist
 
 # reports of jest tests
 reports
+
+docs