Merge pull request #188 from MoiraeSoftware/copilot/fix-e70b52c5-8348-4030-a971-6b49f28ae1d8

Add GitHub Pages deployment for Hugo documentation site with theme fix

Author: 7sharp9

.github/workflows/docs.yml

@@ -0,0 +1,74 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches: [ master ]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+
+# 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
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: '0.128.2'
+          extended: true
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+        if: github.ref == 'refs/heads/master'
+
+      - name: Build with Hugo
+        run: |
+          cd docs
+          hugo \
+            --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+        env:
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        if: github.ref == 'refs/heads/master'
+        with:
+          path: ./docs/public
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Contributing.md

@@ -3,6 +3,19 @@
 2. Run `dotnet tool restore` to install required local tools
 3. Run `dotnet build -c Release -t:Build`
 
+# How to build documentation:
+The documentation is built using Hugo and automatically deployed to GitHub Pages on every push to the master branch.
+
+To build the documentation locally:
+1. Install [Hugo](https://gohugo.io/getting-started/installing/) (version 0.126.3 or later)
+2. Navigate to the `docs` directory: `cd docs`
+3. Initialize the theme submodule: `git submodule update --init --recursive`
+4. Build the site: `hugo --minify`
+5. The generated site will be in the `docs/public` directory
+6. To preview locally: `hugo server` (available at http://localhost:1313/myriad/)
+
+The documentation is automatically published to https://moiraesoftware.github.io/myriad/ via GitHub Actions.
+
 # How to debug:
 - uncomment line `<!-- <MyriadSdkWaitForDebugger>true</MyriadSdkWaitForDebugger> -->` in test\Myriad.IntegrationPluginTests\Myriad.IntegrationPluginTests.fsproj
 - `dotnet build test\Myriad.IntegrationPluginTests -v n` the test project