build_docs.yml

name: Build and Deploy Docs

on:
  push:
    branches:
      - main  # Replace with your default branch if different

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Node.js (if your docs use Node.js tools)
        uses: actions/setup-node@v3
        with:
          node-version: '18'  # Adjust the version as needed

      - name: Install dependencies
        run: npm install  # Replace with your package manager if different

      - name: Build documentation
        run: npm run build:docs  # Replace with your build command

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs  # Replace with the path to your built docs

  deploy:
    runs-on: ubuntu-latest
    needs: build
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4