docs: architecture documentation

Co-authored-by: u207365 <[email protected]>

.github/workflows/documentation-gh-pages.yml

@@ -0,0 +1,84 @@
+# Based on Hugo https://gohugo.io/ and hextra https://imfing.github.io/hextra/
+name: Deploy documentation to Pages
+
+on:
+  push:
+    paths:
+      - 'docs/**'
+    branches: ["main"]
+  pull_request:
+    paths:
+      - 'docs/**'
+    branches: [ "main" ]
+
+  # 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
+  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
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+    working-directory: docs/hugo-config
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.139.0
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # fetch all history for .GitInfo and .Lastmod
+          submodules: recursive
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+          cache-dependency-path: '**/go.sum'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Setup Hugo
+        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: Build with Hugo
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+        run: |
+          hugo \
+            --gc --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/hugo-config/public'
+
+  # Deployment job
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    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

.gitignore

@@ -35,3 +35,7 @@ build/
 
 ### VS Code ###
 .vscode/
+
+### Documentation ###
+/docs/hugo-config/public/
+

docs/ARCHITECTURE.md

@@ -0,0 +1,27 @@
+# Architecture documentation
+
+## Introduction
+Please see the [content/architecture/](content/architecture) folder for the architecture documentation. The content is organized according to the [arc42](https://arc42.org/) template.
+
+## Technical details
+* Documentation is written in Markdown.
+* Diagrams are created in [diagrams.net/draw.io](https://www.drawio.com/) format and stored as SVG. Editors are available online or as a plugin for your favourite IDE.
+* The documentation is using the [HUGO](https://gohugo.io/) framework for site generation. 
+* The theme is based on [hextra](https://github.com/imfing/hextra). See the [documentation](https://imfing.github.io/hextra/docs/) to learn more about advanced features.
+
+## Writing documentation
+Simply contribute to the existing Markdown and SVG files.
+
+Each Markdown file has a header section called [front matter](https://gohugo.io/content-management/front-matter/) containing metadata for HUGO.
+
+If you need more Markdown features, see the [configuration](https://gohugo.io/getting-started/configuration-markup/) section in the HUGO documentation.
+
+## Building the site locally
+1. [Install HUGO](https://gohugo.io/installation/)
+2. `cd docs/hugo-config`
+3. Run `hugo server --buildDrafts`
+4. Open [localhost:1313](http://localhost:1313/) in your browser
+
+## Update hextra theme
+1. `cd docs/hugo-config`
+2. `hugo mod get -u`