Merge pull request #136 from wieslawsoltes/docs/lunet-site-panandzoom

Add Lunet Documentation Site for PanAndZoom

Author: wieslawsoltes

.config/dotnet-tools.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "lunet": {
+      "version": "1.0.10",
+      "commands": [
+        "lunet"
+      ],
+      "rollForward": false
+    }
+  }
+}

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET SDKs
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            10.0.x
+            8.0.x
+
+      - name: Restore local tools
+        run: dotnet tool restore
+
+      - name: Build docs
+        run: |
+          chmod +x build-docs.sh
+          ./build-docs.sh
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site/.lunet/build/www

.gitignore

@@ -289,3 +289,6 @@ tools/**
 
 # macOS
 .DS_Store
+
+# Documentation output
+/site/.lunet/build/

README.md

@@ -33,6 +33,9 @@ You can install the package for `Avalonia` based projects like this:
 ## Resources
 
 * [GitHub source code repository.](https://github.com/wieslawsoltes/PanAndZoom)
+* [Documentation site.](https://wieslawsoltes.github.io/PanAndZoom)
+* [Articles home.](site/articles/readme.md)
+* [Headless testing docs.](site/articles/headless-testing/readme.md)
 
 ## Using PanAndZoom
 
@@ -699,6 +702,33 @@ zoomBorder.ImportState(restoredState);
 - Implement undo/redo functionality
 - Session state management
 
+## Documentation
+
+The repository now includes a Lunet-based documentation site, modeled after the TreeDataGrid docs pipeline and tailored to `PanAndZoom` and `HeadlessTestingFramework`.
+
+Key entry points:
+
+- [Docs home](site/readme.md)
+- [Getting Started](site/articles/getting-started/readme.md)
+- [Headless Testing](site/articles/headless-testing/readme.md)
+- [Reference](site/articles/reference/readme.md)
+
+Build docs locally:
+
+```bash
+./build-docs.sh
+./serve-docs.sh
+```
+
+PowerShell:
+
+```powershell
+./build-docs.ps1
+./serve-docs.ps1
+```
+
+Generated output is written to `site/.lunet/build/www`.
+
 ## License
 
 PanAndZoom is licensed under the [MIT license](LICENSE.TXT).

build-docs.ps1

@@ -0,0 +1,10 @@
+$ErrorActionPreference = 'Stop'
+
+dotnet tool restore
+Push-Location site
+try {
+    dotnet tool run lunet --stacktrace build
+}
+finally {
+    Pop-Location
+}

build-docs.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+
+dotnet tool restore
+cd site
+dotnet tool run lunet --stacktrace build

check-docs.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+
+dotnet tool restore
+cd site
+dotnet tool run lunet --stacktrace build

serve-docs.ps1

@@ -0,0 +1,51 @@
+$ErrorActionPreference = 'Stop'
+
+$hostAddress = if ($env:DOCS_HOST) { $env:DOCS_HOST } else { '127.0.0.1' }
+$port = if ($env:DOCS_PORT) { $env:DOCS_PORT } else { '8080' }
+
+dotnet tool restore
+Push-Location site
+try {
+    if (Get-Command python3 -ErrorAction SilentlyContinue) {
+        $pythonCommand = 'python3'
+        $pythonArgs = @('-m', 'http.server', $port, '--bind', $hostAddress)
+    } elseif (Get-Command python -ErrorAction SilentlyContinue) {
+        $pythonCommand = 'python'
+        $pythonArgs = @('-m', 'http.server', $port, '--bind', $hostAddress)
+    } elseif (Get-Command py -ErrorAction SilentlyContinue) {
+        $pythonCommand = 'py'
+        $pythonArgs = @('-3', '-m', 'http.server', $port, '--bind', $hostAddress)
+    } else {
+        Write-Warning "Python runtime not found (python3/python/py). Falling back to 'lunet serve'."
+        dotnet tool run lunet --stacktrace serve
+        return
+    }
+
+    dotnet tool run lunet --stacktrace build --dev
+
+    $watcher = Start-Process -FilePath 'dotnet' `
+        -ArgumentList @('tool', 'run', 'lunet', '--stacktrace', 'build', '--dev', '--watch') `
+        -NoNewWindow `
+        -PassThru
+
+    try {
+        Write-Host "Serving docs at http://${hostAddress}:$port"
+        Write-Host 'Watching docs with Lunet (dev mode)...'
+
+        Push-Location '.lunet/build/www'
+        try {
+            & $pythonCommand @pythonArgs
+        }
+        finally {
+            Pop-Location
+        }
+    }
+    finally {
+        if ($watcher -and -not $watcher.HasExited) {
+            Stop-Process -Id $watcher.Id -Force
+        }
+    }
+}
+finally {
+    Pop-Location
+}

serve-docs.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+set -euo pipefail
+
+HOST="${DOCS_HOST:-127.0.0.1}"
+PORT="${DOCS_PORT:-8080}"
+
+dotnet tool restore
+cd site
+
+if command -v python3 >/dev/null 2>&1; then
+    PYTHON_BIN="python3"
+elif command -v python >/dev/null 2>&1; then
+    PYTHON_BIN="python"
+else
+    echo "Python runtime not found (python3/python). Falling back to 'lunet serve'." >&2
+    dotnet tool run lunet --stacktrace serve
+    exit 0
+fi
+
+dotnet tool run lunet --stacktrace build --dev
+
+dotnet tool run lunet --stacktrace build --dev --watch &
+LUNET_WATCH_PID=$!
+
+cleanup() {
+    kill "${LUNET_WATCH_PID}" >/dev/null 2>&1 || true
+}
+
+trap cleanup EXIT INT TERM
+
+echo "Serving docs at http://${HOST}:${PORT}"
+echo "Watching docs with Lunet (dev mode)..."
+
+cd .lunet/build/www
+"${PYTHON_BIN}" -m http.server "${PORT}" --bind "${HOST}"