docs and tests

Author: ngmachado

.github/workflows/ci.yml

@@ -238,7 +238,15 @@ jobs:
             # Try to compile each .ora file (if we have a compiler binary)
             if [ -f "zig-out/bin/ora" ]; then
               echo "🚀 Testing compiler on examples..."
-              find examples/ -name "*.ora" -exec echo "Compiling: {}" \; -exec ./zig-out/bin/ora {} \; || echo "⚠️  Some examples failed to compile"
+              
+              # Run general examples test
+              if [ -f "scripts/test-examples.sh" ]; then
+                echo "📜 Running test-examples.sh script..."
+                ./scripts/test-examples.sh || echo "⚠️  Some examples failed via test script"
+              else
+                echo "ℹ️  No test-examples.sh script found, trying manual compilation..."
+                find examples/ -name "*.ora" -exec echo "Compiling: {}" \; -exec ./zig-out/bin/ora {} \; || echo "⚠️  Some examples failed to compile"
+              fi
             else
               echo "ℹ️  No compiler binary found, skipping example compilation"
             fi
@@ -248,6 +256,80 @@ jobs:
           
           echo "✅ Examples processing completed"
 
+  struct-tests:
+    name: Struct Implementation Tests
+    runs-on: ${{ matrix.os }}
+    needs: [lint, test]
+    
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: ${{ env.ZIG_VERSION }}
+
+      - name: Install system dependencies
+        run: |
+          echo "🔧 Installing system dependencies for ${{ runner.os }}..."
+          case "${{ runner.os }}" in
+            Linux)
+              sudo apt-get update -qq
+              sudo apt-get install -y \
+                build-essential \
+                cmake \
+                libboost-all-dev \
+                libssl-dev \
+                pkg-config \
+                git
+              echo "✅ Linux dependencies installed"
+              ;;
+            macOS)
+              brew update
+              brew install boost openssl cmake
+              echo "✅ macOS dependencies installed"
+              ;;
+            Windows)
+              choco install boost-msvc-14.3 cmake openssl
+              echo "✅ Windows dependencies installed"
+              ;;
+          esac
+
+      - name: Cache Zig artifacts
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/zig
+            .zig-cache
+          key: ${{ runner.os }}-zig-${{ env.ZIG_VERSION }}-${{ hashFiles('build.zig', 'build.zig.zon') }}
+          restore-keys: |
+            ${{ runner.os }}-zig-${{ env.ZIG_VERSION }}-
+
+      - name: Run struct tests
+        run: |
+          echo "🏗️  Running comprehensive struct tests..."
+          ./scripts/test-struct-examples.sh
+
+      - name: Run struct performance benchmarks
+        run: |
+          echo "⚡ Running struct performance benchmarks..."
+          ./scripts/test-struct-examples.sh --benchmark
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: struct-test-results-${{ matrix.os }}
+          path: test-results/
+          retention-days: 30
+
       - name: Upload build artifacts
         uses: actions/upload-artifact@v4
         if: success()
@@ -372,7 +454,7 @@ jobs:
     name: Release Check
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'
-    needs: [lint, test, examples, security]
+    needs: [lint, test, examples, struct-tests, security]
 
     steps:
       - name: Checkout code
@@ -444,11 +526,11 @@ jobs:
     name: Notification
     runs-on: ubuntu-latest
     if: always()
-    needs: [lint, test, examples, security]
+    needs: [lint, test, examples, struct-tests, security]
 
     steps:
       - name: Notify on success
-        if: needs.lint.result == 'success' && needs.test.result == 'success' && needs.examples.result == 'success'
+        if: needs.lint.result == 'success' && needs.test.result == 'success' && needs.examples.result == 'success' && needs.struct-tests.result == 'success'
         run: |
           echo "✅ 🎉 All CI checks passed successfully!"
           echo "📊 Results:"

scripts/generate-docs.sh

@@ -10,15 +10,52 @@ echo "🔨 Generating Zig documentation..."
 # Generate Zig docs
 zig build docs
 
-echo "📁 Copying documentation to website..."
+echo "📁 Processing documentation for website..."
 
 # Create target directory if it doesn't exist
 mkdir -p website/static/api-docs
 
 # Copy generated docs to website static folder
 cp -r zig-out/docs/* website/static/api-docs/
 
-echo "✅ API documentation generated and copied to website/static/api-docs/"
+# Extract sources.tar if it exists for better accessibility
+if [ -f "website/static/api-docs/sources.tar" ]; then
+    echo "📦 Extracting sources.tar for better web accessibility..."
+    cd website/static/api-docs
+    tar -xf sources.tar
+    # Create a simple redirect index for the extracted content
+    if [ -d "src" ]; then
+        echo '<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <title>Ora API Documentation</title>
+    <style>
+        body { font-family: system-ui, -apple-system, sans-serif; margin: 40px; }
+        h1 { color: #2563eb; }
+        .links { margin-top: 20px; }
+        .links a { display: block; margin: 10px 0; color: #1d4ed8; text-decoration: none; }
+        .links a:hover { text-decoration: underline; }
+    </style>
+</head>
+<body>
+    <h1>Ora API Documentation</h1>
+    <div class="links">
+        <a href="src/root.zig.html">Root Module</a>
+        <a href="src/ast.zig.html">AST Module</a>
+        <a href="src/typer.zig.html">Type System</a>
+        <a href="src/ir.zig.html">IR (HIR) Module</a>
+        <a href="src/codegen_yul.zig.html">Yul Code Generation</a>
+        <a href="src/parser.zig.html">Parser Module</a>
+        <a href="src/lexer.zig.html">Lexer Module</a>
+    </div>
+</body>
+</html>' > docs-index.html
+    fi
+    cd ../../..
+fi
+
+echo "✅ API documentation generated and processed for website/static/api-docs/"
 echo "📖 Documentation will be available at /api-docs/ when the website is built"
 
 # Optional: Start development server if requested