Migrate docs to github pages via ci cd

.github/workflows/deploy.yml

@@ -29,22 +29,30 @@ jobs:
 
   docs:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.11'
       - name: Install uv
         uses: astral-sh/setup-uv@v6
       - name: Sync dependencies
         run: uv sync --group dev
       - name: Build documentation
-        run: uv run mkdocs build
-      - name: Deploy to Cloudflare Pages
-        uses: cloudflare/pages-action@v1
+        run: uv run build-docs
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          projectName: intent-kit-docs
-          directory: site
-          gitHubToken: ${{ secrets.GH_DEPLOY_TOKEN }}
+          path: './docs-site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pages.yml

@@ -0,0 +1,55 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Sync dependencies
+        run: uv sync --group dev
+
+      - name: Build documentation
+        run: uv run build-docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs-site'
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -8,10 +8,10 @@ Build reliable, auditable AI applications that understand user intent and take i
   [![Downloads](https://static.pepy.tech/badge/intentkit-py/month)](https://pepy.tech/project/intentkit-py)
   [![Versions](https://img.shields.io/pypi/pyversions/intentkit-py.svg)](https://github.com/Stephen-Collins-tech/intent-kit)
   [![License](https://img.shields.io/github/license/Stephen-Collins-tech/intent-kit.svg)](https://github.com/Stephen-Collins-tech/intent-kit/blob/main/LICENSE)
-  [![Documentation](https://img.shields.io/badge/docs-online-blue)](https://docs.intentkit.io)
+  [![Documentation](https://img.shields.io/badge/docs-online-blue)](https://stephen-collins-tech.github.io/intent-kit)
 
 <p align="center">
-  <a href="https://docs.intentkit.io">Docs</a>
+  <a href="https://stephen-collins-tech.github.io/intent-kit">Docs</a>
 </p>
 
 ---

docs/404.md

@@ -0,0 +1,10 @@
+# Page Not Found
+
+The page you're looking for doesn't exist. Here are some helpful links:
+
+- [Home](/index.html)
+- [Quickstart](/quickstart.html)
+- [API Reference](/api/api-reference.html)
+- [Examples](/examples/index.html)
+
+If you think this is an error, please [report an issue](https://github.com/Stephen-Collins-tech/intent-kit/issues) on GitHub.

docs/robots.txt

@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://stephen-collins-tech.github.io/intent-kit/sitemap.xml

pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
 
 [project.urls]
 Homepage = "https://github.com/Stephen-Collins-tech/intent-kit"
-Documentation = "https://docs.intentkit.io"
+Documentation = "https://stephen-collins-tech.github.io/intent-kit"
 Repository = "https://github.com/Stephen-Collins-tech/intent-kit"
 "Bug Tracker" = "https://github.com/Stephen-Collins-tech/intent-kit/issues"
 
@@ -64,6 +64,7 @@ example = "scripts.examples:run_single"
 list-examples = "scripts.examples:list_examples"
 security = "scripts.security:main"
 auto-amend = "scripts.auto_amend:main"
+build-docs = "scripts.build_docs:main"
 
 [tool.setuptools.packages.find]
 where = ["."]
@@ -80,10 +81,8 @@ dev = [
     "coverage>=7.0",
     "intentkit-py[all]",
     "ipykernel>=6.0.0",
-    "mkdocs-literate-nav>=0.6.0",
-    "mkdocs-material>=9.5.17",
-    "mkdocs>=1.5.0",
-    "mkdocstrings[python]>=0.24.0",
+    "jinja2>=3.1.0",
+    "markdown>=3.5.0",
     "mypy>=1.10.0",
     "pre-commit>=3.6.0",
     "pytest-cov>=5.0",