Docs/starlight docs

.github/actions/build-documentation/action.yml

@@ -0,0 +1,48 @@
+name: "Build Documentation"
+description: "Build Astro Starlight documentation using hatch"
+inputs:
+  node-version:
+    description: "Node.js version"
+    required: false
+    default: "22.x"
+  upload-pages-artifact:
+    description: "Upload docs/dist as a GitHub Pages artifact"
+    required: false
+    default: "true"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+        cache: "pip"
+
+    - name: Install hatch
+      shell: bash
+      run: pip install hatch
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ inputs.node-version }}
+
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v4
+      with:
+        package_json_file: docs/package.json
+
+    - name: Install docs dependencies
+      shell: bash
+      run: pnpm install --frozen-lockfile --dir docs
+
+    - name: Build docs
+      shell: bash
+      run: hatch run docs:build
+
+    - name: Upload Pages artifact
+      if: inputs.upload-pages-artifact == 'true'
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/dist

.github/workflows/ci.yaml

@@ -22,6 +22,19 @@ jobs:
       - name: Install hatch
         run: pip install hatch
 
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22.x"
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          package_json_file: docs/package.json
+
+      - name: Install docs dependencies
+        run: pnpm install --frozen-lockfile --dir docs
+
       - name: Start LocalNet
         run: pipx install algokit && algokit localnet start
 
@@ -37,8 +50,8 @@ jobs:
       - name: Check wheels can be built
         run: hatch build
 
-      - name: Check doctests
-        run: hatch run docs:test
+      - name: Build docs
+        run: hatch run docs:build
 
   test-python-matrix:
     runs-on: "ubuntu-latest"

.github/workflows/gh-pages.yaml

@@ -1,11 +1,11 @@
-name: "Sphinx: Render + publish docs"
+name: Publish docs to GitHub Pages
 
 on:
   workflow_call:
   workflow_dispatch:
 
 jobs:
-  build:
+  build-and-publish-docs:
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -15,25 +15,11 @@ jobs:
       - name: Checkout source code
         uses: actions/checkout@v4
 
-      - name: Install hatch
-        run: pipx install hatch
-
-      - name: Set up Python 3.12
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-          cache: "pip"
-
-      - name: Test doctests
-        run: hatch run docs:test
-
-      - name: Build doc
-        run: hatch run docs:build
-
-      - name: Upload to GitHub pages
-        uses: actions/upload-pages-artifact@v3
+      - name: Build and upload docs artifact
+        uses: ./.github/actions/build-documentation
         with:
-          path: docs/_build
+          node-version: 22.x
+          upload-pages-artifact: 'true'
 
       - name: Deploy to GitHub Pages
         uses: actions/deploy-pages@v4

.github/workflows/publish-devportal-docs.yml

@@ -0,0 +1,39 @@
+name: Publish DevPortal Docs
+
+on:
+  workflow_dispatch:
+  push:
+    tags: ['v*']
+
+permissions:
+  contents: write
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 22
+
+      - uses: pnpm/action-setup@v4
+        with:
+          package_json_file: docs/package.json
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: pip
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Generate API docs
+        run: hatch run docs:api
+
+      - name: Publish DevPortal Docs
+        uses: algorandfoundation/devportal/.github/actions/publish-devportal-docs@ci/update-publish-devportal-docs-workflow
+        with:
+          docs-dir: docs

.gitignore

@@ -18,3 +18,6 @@ coverage.xml
 
 .cursorignore
 *.puya.map
+
+# AI Agents
+.codex