Skip to content

feat: add demo command + comprehensive documentation overhaul #23

feat: add demo command + comprehensive documentation overhaul

feat: add demo command + comprehensive documentation overhaul #23

Workflow file for this run

name: Docs
env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: write
pages: write
jobs:
docs:
name: Deploy Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install uv
uses: astral-sh/setup-uv@v5
- name: Install docs dependencies
run: uv sync --group docs
- name: Configure git
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
- name: Fetch gh-pages branch
run: |
git fetch origin gh-pages:gh-pages || echo "No gh-pages branch exists yet — mike will create it"
- name: Deploy docs (main branch — dev alias)
id: deploy_dev
run: |
uv run mike deploy --push --update-aliases dev
continue-on-error: true
- name: Retry docs deployment on failure
if: steps.deploy_dev.outcome == 'failure'
run: |
echo "Retrying documentation deployment..."
git fetch origin gh-pages:gh-pages --force
uv run mike deploy --push --update-aliases --force dev