Skip to content

[NRCL-67] Add versioned cross-runtime contract bundle #103

[NRCL-67] Add versioned cross-runtime contract bundle

[NRCL-67] Add versioned cross-runtime contract bundle #103

Workflow file for this run

name: Documentation
on:
push:
branches: [main, develop]
paths:
- "docs/**"
- "docs-site/**"
- "examples/**"
- "neural/**/*.py"
- "README.md"
- "CONTRIBUTING.md"
- ".github/workflows/docs.yml"
pull_request:
branches: [main]
paths:
- "docs/**"
- "docs-site/**"
- "examples/**"
- "neural/**/*.py"
- "README.md"
- "CONTRIBUTING.md"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
jobs:
content:
name: Validate Documentation Content
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up uv
uses: astral-sh/setup-uv@v7
with:
python-version: "3.11"
enable-cache: true
- name: Sync Python validation dependencies
run: uv sync --extra dev
- name: Validate documentation
run: uv run python scripts/validate_docs.py
- name: Validate examples
run: uv run python scripts/validate_examples.py
site:
name: Build Fumadocs Site
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: "1.3.3"
- name: Install locked dependencies
working-directory: docs-site
run: bun install --frozen-lockfile
- name: Typecheck
working-directory: docs-site
run: bun run typecheck
- name: Build
working-directory: docs-site
run: bun run build
- name: Documentation summary
run: |
echo "## Fumadocs validation" >> "$GITHUB_STEP_SUMMARY"
echo "- Fumadocs dependencies installed from bun.lock" >> "$GITHUB_STEP_SUMMARY"
echo "- TypeScript passed" >> "$GITHUB_STEP_SUMMARY"
echo "- Production build passed" >> "$GITHUB_STEP_SUMMARY"
echo "- Deployment intentionally excluded" >> "$GITHUB_STEP_SUMMARY"