Add documentation (#20)

Author: cubahno

.github/workflows/ci.yml

@@ -2,6 +2,8 @@ name: CI
 on:
   pull_request:
     branches: [main]
+    paths-ignore:
+      - 'docs/**'
   workflow_dispatch:
     inputs:
       run_integration:

.github/workflows/deploy-docs.yml

@@ -0,0 +1,24 @@
+name: Deploy Docs
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: make docs-deploy

.nojekyll

@@ -98,3 +98,15 @@ check-fmt:
 build-ci: check-fmt lint-ci gosec
 
 test-ci: test
+
+@PHONY: docs-install
+docs-install:
+	@brew install mkdocs-material
+
+@PHONY: docs-serve
+docs-serve:
+	@mkdocs serve
+
+@PHONY: docs-deploy
+docs-deploy:
+	@mkdocs gh-deploy --force