Docs deployment

Author: steven10a

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Deploy docs
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy_docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: make sync
+      - name: Build docs
+        run: uv run mkdocs build --site-dir site
+      - name: Configure Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Makefile

@@ -22,10 +22,18 @@ test:
 build:
 	npm run build
 
+.PHONY: sync
+sync:
+	uv sync --all-extras --all-packages --group dev
+
 .PHONY: build-docs
 build-docs:
-	mkdocs build
+	uv run mkdocs build
 
 .PHONY: serve-docs
 serve-docs:
-	mkdocs serve
+	uv run mkdocs serve
+
+.PHONY: deploy-docs
+deploy-docs:
+	uv run mkdocs gh-deploy --force --verbose

mkdocs.yml

@@ -1,5 +1,6 @@
 site_name: OpenAI Guardrails TypeScript
-site_dir: .vercel/output/static
+site_url: https://openai.github.io/openai-guardrails-js/
+site_dir: site
 theme:
   name: material
   features:

requirements.txt

@@ -1,3 +1,5 @@
-mkdocs==1.5.3
-mkdocs-material==9.5.3
-mkdocs-mkdocstrings==0.24.0
+mkdocs>=1.6.1
+mkdocs-material>=9.6.14
+mkdocstrings[python]>=0.29.1
+pymdown-extensions>=10.0.0
+mkdocs-i18n>=0.4.3