Feat: Typedoc docs directory adds unnecessary noise to PR (#67)

* Feat: Typedoc docs directory adds unnecessary noise to PR

Solution: create a new branch that will receive the documentation generated through a GitHub Action

Author: Rgascoin

.github/workflows/doc.yaml

@@ -0,0 +1,52 @@
+name: Generate Doc
+
+on:
+  push:
+    branches: [main]
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  Doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Caching Nodes.js modules
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Create Doc
+        run: yarn doc
+
+      - name: Push Doc
+        run: |
+          BRANCH=gh-pages
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+
+          git fetch origin $BRANCH
+          git reset --mixed origin/$BRANCH
+          git add -f docs
+
+          git commit -m "Updating documentation: $GITHUB_ACTOR"
+          git push origin HEAD:$BRANCH

.gitignore

@@ -106,3 +106,6 @@ dist
 
 # Custom
 .idea
+
+# Documentation
+docs/