(#235) New docs site based on mkdocs (#267)

* (#144, #235) Mkdocs site with getting started guide

* (#251) Fixed code sample on configuring entities to synchronize

* (#235) GitHub Action for deploying gh-pages

Author: adrianhall

.github/workflows/build-docs.yml

@@ -1,9 +1,9 @@
-name: Deploy Hugo site to Pages
+name: Deploy documentation site to Pages
 
 on:
   push:
     branches: [ main ]
-    paths: [ 'docs/**' ]
+    paths: [ 'docs/**', 'mkdocs.yml' ]
   workflow_dispatch:
 
 permissions:
@@ -22,45 +22,14 @@ defaults:
 jobs:
   build:
     runs-on: ubuntu-latest
-    env:
-      HUGO_VERSION: 0.132.0
     steps:
-      - name: Install Hugo CLI
-        run: |
-          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
-          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
-
       - name: Checkout Repository
         uses: actions/checkout@v4
         with:
-          submodules: recursive
           fetch-depth: 0
 
-      - name: Setup Pages
-        id: pages
-        uses: actions/configure-pages@v5
-
-      - name: Build with Hugo
-        env:
-          HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
-          HUGO_ENVIRONMENT: production
-          TZ: America/Los_Angeles
-        run: hugo --gc --minify --baseURL "${{ steps.pages.outputs.base_url }}/"
-        working-directory: ./docs
-      
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+      - uses: actions/setup-python@v5
         with:
-          path: ./docs/public
-
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
-
+          python-version: 3.x
+      - run: pip install mkdocs
+      - run: mkdocs gh-deploy --clean --force --verbose