Add: Documentation workflow for Markdown validation

Author: greggh

.github/workflows/docs.yml

@@ -0,0 +1,93 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'README.md'
+      - 'CONTRIBUTING.md'
+      - 'DEVELOPMENT.md'
+      - 'CHANGELOG.md'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'README.md'
+      - 'CONTRIBUTING.md'
+      - 'DEVELOPMENT.md'
+      - 'CHANGELOG.md'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+jobs:
+  markdown-lint:
+    name: Markdown Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install markdownlint-cli
+        run: npm install -g markdownlint-cli@0.37.0
+      
+      - name: Run markdownlint
+        run: markdownlint '**/*.md' --config .markdownlint.json || true
+        
+  check-links:
+    name: Check Links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1.8.0
+        with:
+          args: --verbose --no-progress '**/*.md'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          
+  validate-lua-examples:
+    name: Validate Lua Examples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Lua
+        uses: leafo/gh-actions-lua@v10
+        with:
+          luaVersion: "5.1"
+      
+      - name: Check Lua code blocks in markdown
+        run: |
+          find . -type f -name "*.md" -exec grep -l '```lua' {} \; | while read -r file; do
+            echo "Checking Lua snippets in $file"
+            
+            # Create a temporary directory for the snippets
+            TEMP_DIR=$(mktemp -d)
+            
+            # Extract Lua code blocks
+            grep -n '^```lua$' "$file" | while read -r line_start; do
+              # Get the line number where the lua block starts
+              line_num=$(echo "$line_start" | cut -d: -f1)
+              
+              # Find the line number where the next ``` appears
+              line_end=$(tail -n +$((line_num+1)) "$file" | grep -n '^```$' | head -1 | cut -d: -f1)
+              if [ -n "$line_end" ]; then
+                line_end=$((line_num + line_end))
+                
+                # Extract the lua snippet
+                snippet_file="${TEMP_DIR}/snippet_${line_num}.lua"
+                sed -n "$((line_num+1)),$((line_end-1))p" "$file" > "$snippet_file"
+                
+                # Check syntax if file is not empty
+                if [ -s "$snippet_file" ]; then
+                  echo "  Checking snippet starting at line $line_num in $file"
+                  luac -p "$snippet_file" || echo "Syntax error in $file at line $line_num"
+                fi
+              fi
+            done
+            
+            # Clean up
+            rm -rf "$TEMP_DIR"
+          done