update(ci): check documentation for all products

Author: Tom-Ryder

.github/workflows/ci.yml

@@ -3,9 +3,7 @@ name: CI
 on:
   push:
     branches: [main]
-    paths-ignore: ['**.md']
   pull_request:
-    paths-ignore: ['**.md']
 
 permissions:
   contents: read
@@ -51,18 +49,35 @@ jobs:
       - name: Run tests
         run: swift test --parallel -Xswiftc -warnings-as-errors
 
+  docs:
+    runs-on: macos-26
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+      - uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
+        with:
+          path: .build
+          key: macos-docs-spm-${{ hashFiles('Package.resolved', 'Package.swift') }}
+          restore-keys: macos-docs-spm-
+      - name: Generate documentation
+        run: make docs
+
   check:
     if: always()
-    needs: [lint, test-macos]
+    needs: [lint, test-macos, docs]
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
       - name: Verify all jobs passed
         run: |
           if [[ "${{ needs.lint.result }}" != "success" || \
-                "${{ needs.test-macos.result }}" != "success" ]]; then
+                "${{ needs.test-macos.result }}" != "success" || \
+                "${{ needs.docs.result }}" != "success" ]]; then
             echo "Required jobs failed:"
             echo "  lint: ${{ needs.lint.result }}"
             echo "  test-macos: ${{ needs.test-macos.result }}"
+            echo "  docs: ${{ needs.docs.result }}"
             exit 1
           fi

.gitignore

@@ -4,5 +4,4 @@
 xcuserdata/
 DerivedData/
 .DS_Store
-Package.resolved
 .env

.spi.yml

@@ -1,4 +1,8 @@
 version: 1
 builder:
   configs:
-    - documentation_targets: [AgentRunKit, AgentRunKitTesting]
+    - documentation_targets:
+        - AgentRunKit
+        - AgentRunKitTesting
+        - AgentRunKitFoundationModels
+        - AgentRunKitMLX

Makefile

@@ -20,6 +20,9 @@ check: format lint test
 
 docs:
 	swift package generate-documentation --target AgentRunKit
+	swift package generate-documentation --target AgentRunKitTesting
+	swift package generate-documentation --target AgentRunKitFoundationModels
+	swift package generate-documentation --target AgentRunKitMLX
 
 docs-preview:
 	swift package --disable-sandbox preview-documentation --target AgentRunKit

Package.resolved

@@ -6,7 +6,7 @@ On-device LLM inference via Apple's Foundation Models framework.
 
 AgentRunKitFoundationModels bridges AgentRunKit to Apple's on-device foundation model. Use `Agent.onDevice(tools:context:instructions:)` as the primary entry point, or construct a ``FoundationModelsClient`` directly. The same tools, agent loop, and streaming API work on-device with no network access required. Requires macOS 26+ or iOS 26+ with Apple Intelligence enabled.
 
-``Chat`` and direct ``FoundationModelsClient`` usage are supported for single-turn interactions: `Chat.send()` returns an `AssistantMessage` with text in `content`, and `Chat.stream()` terminates on content-only iterations the same way it does for cloud clients. Multi-turn conversations are currently limited: only the most recent user turn is forwarded to the on-device session, so prior assistant and tool messages are not yet preserved across turns. Full history linearization is tracked as a follow-up.
+`Chat` and direct ``FoundationModelsClient`` usage are supported for single-turn interactions: `Chat.send()` returns an `AssistantMessage` with text in `content`, and `Chat.stream()` terminates on content-only iterations the same way it does for cloud clients. Multi-turn conversations are currently limited: only the most recent user turn is forwarded to the on-device session, so prior assistant and tool messages are not yet preserved across turns. Full history linearization is tracked as a follow-up.
 
 ## Topics
 

Sources/AgentRunKitFoundationModels/Documentation.docc/AgentRunKitFoundationModels.md

@@ -0,0 +1,15 @@
+# ``AgentRunKitMLX``
+
+On-device LLM inference via MLX.
+
+## Overview
+
+AgentRunKitMLX bridges AgentRunKit to `mlx-swift-lm` through ``MLXClient``. Use it when an app wants local generation with the same AgentRunKit messages, tools, streaming deltas, and agent loop used by cloud clients.
+
+MLX generation supports tool calls, streaming, request parameter overrides through `RequestContext.extraFields`, and reasoning extraction from `<think>` tags. Structured output via `ResponseFormat` is not supported by this client.
+
+## Topics
+
+### Client
+
+- ``MLXClient``