Skip to content

armgit / cua

Public Imported from GitHub
0

Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.

Add documentation link checker CI workflow (#1034)

r33drichardse22eacae1823
diff --git a/.github/workflows/ci-check-docs-links.yml b/.github/workflows/ci-check-docs-links.yml
new file mode 100644
index 0000000000..5080f2ff47
--- /dev/null
+++ b/.github/workflows/ci-check-docs-links.yml
@@ -0,0 +1,70 @@
+name: "CI: Check Docs Links"
+
+on:
+ pull_request:
+ paths:
+ - "docs/content/**"
+ - "docs/src/**"
+ - "docs/scripts/check-links.ts"
+
+jobs:
+ check-internal-links:
+ name: Check Internal Links (next-validate-link)
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: "20"
+
+ - name: Install pnpm
+ uses: pnpm/action-setup@v4
+
+ - name: Install dependencies
+ run: pnpm install
+ working-directory: docs
+
+ - name: Check internal links
+ run: pnpm docs:check-links
+ working-directory: docs
+
+ - name: Show help if check failed
+ if: failure()
+ run: |
+ echo ""
+ echo "╔══════════════════════════════════════════════════════════════════╗"
+ echo "║ Broken Documentation Links! ║"
+ echo "╠══════════════════════════════════════════════════════════════════╣"
+ echo "║ ║"
+ echo "║ One or more internal links in the documentation are broken. ║"
+ echo "║ ║"
+ echo "║ To find broken links locally, run from the docs/ directory: ║"
+ echo "║ ║"
+ echo "║ pnpm docs:check-links ║"
+ echo "║ ║"
+ echo "╚══════════════════════════════════════════════════════════════════╝"
+
+ check-external-links:
+ name: Check External Links (lychee)
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Check external links
+ uses: lycheeverse/lychee-action@v2
+ with:
+ args: >-
+ --verbose
+ --no-progress
+ --accept 100..=399
+ --exclude '^file://'
+ --exclude 'localhost'
+ --exclude '127\.0\.0\.1'
+ --exclude 'example\.com'
+ './docs/content/**/*.mdx'
+ token: ${{ secrets.GITHUB_TOKEN }}
+ fail: true
diff --git a/docs/content/docs/cua/examples/ai-models/gemini-complex-ui-navigation.mdx b/docs/content/docs/cua/examples/ai-models/gemini-complex-ui-navigation.mdx
index 5b98f79fe2..5132507601 100644
--- a/docs/content/docs/cua/examples/ai-models/gemini-complex-ui-navigation.mdx
+++ b/docs/content/docs/cua/examples/ai-models/gemini-complex-ui-navigation.mdx
@@ -131,7 +131,7 @@ Replace the values:
- `your-project-id`: Your Google Cloud Project ID from Step 1
- `/path/to/your-service-account-key.json`: Path to the JSON key file you downloaded
-- `sk_cua-api01...`: Your Cua API key from the [Cua dashboard](https://cua.dev)
+- `sk_cua-api01...`: Your Cua API key from the [Cua dashboard](https://cua.ai)
- `your-sandbox-name`: Your sandbox name (if using cloud sandboxes)
</Step>
diff --git a/docs/content/docs/cua/examples/automation/form-filling.mdx b/docs/content/docs/cua/examples/automation/form-filling.mdx
index 1885b1af6b..9935a7975f 100644
--- a/docs/content/docs/cua/examples/automation/form-filling.mdx
+++ b/docs/content/docs/cua/examples/automation/form-filling.mdx
@@ -495,6 +495,6 @@ Monitor the output to see the agent's progress through each task.
## Next Steps
- Learn more about [Cua Computer Framework](/cua/reference/computer-sdk) and [Computer Commands](/cua/reference/computer-sdk)
-- Read about [Agent Loops](/cua/guide/fundamentals/agent-loops), [Tools](/cua/guide/advanced/custom-tools), and [Supported Model Providers](/cua/guide/fundamentals/vlms/)
-- Experiment with different [Models and Providers](/cua/guide/fundamentals/vlms/)
+- Read about [Agent Loops](/cua/guide/fundamentals/agent-loops), [Tools](/cua/guide/advanced/custom-tools), and [Supported Model Providers](/cua/guide/fundamentals/vlms)
+- Experiment with different [Models and Providers](/cua/guide/fundamentals/vlms)
- Join our [Discord community](https://discord.com/invite/mVnXXpdE85) for help
diff --git a/docs/content/docs/cua/examples/automation/post-event-contact-export.mdx b/docs/content/docs/cua/examples/automation/post-event-contact-export.mdx
index 5dd3f7c5fc..0ce29b6097 100644
--- a/docs/content/docs/cua/examples/automation/post-event-contact-export.mdx
+++ b/docs/content/docs/cua/examples/automation/post-event-contact-export.mdx
@@ -86,7 +86,7 @@ CUA_API_KEY=sk_cua-api01...
CUA_CONTAINER_NAME=m-linux-...
```
-Finally, setup your sandbox. Refer to the [quickstart guide](https://cua.ai/docs/get-started/quickstart) on how to setup the computer environment.
+Finally, setup your sandbox. Refer to the [quickstart guide](/cua/guide/get-started/quickstart) on how to setup the computer environment.
</Step>
@@ -476,7 +476,7 @@ This script demonstrates a practical workflow for extracting LinkedIn connection
## Next Steps
- Learn more about [Cua Computer Framework](/cua/reference/computer-sdk) and [Computer Commands](/cua/reference/computer-sdk)
-- Read about [Agent Loops](/cua/guide/fundamentals/agent-loops), [Tools](/cua/guide/advanced/custom-tools), and [Supported Model Providers](/cua/guide/fundamentals/vlms/)
-- Experiment with different [Models and Providers](/cua/guide/fundamentals/vlms/)
+- Read about [Agent Loops](/cua/guide/fundamentals/agent-loops), [Tools](/cua/guide/advanced/custom-tools), and [Supported Model Providers](/cua/guide/fundamentals/vlms)
+- Experiment with different [Models and Providers](/cua/guide/fundamentals/vlms)
- Adapt this script for other platforms (Twitter/X, email extraction, etc.)
- Join our [Discord community](https://discord.com/invite/mVnXXpdE85) for help
diff --git a/docs/content/docs/cua/guide/advanced/demonstration-guided-skills.mdx b/docs/content/docs/cua/guide/advanced/demonstration-guided-skills.mdx
index 7e3386fb17..c49156bb85 100644
--- a/docs/content/docs/cua/guide/advanced/demonstration-guided-skills.mdx
+++ b/docs/content/docs/cua/guide/advanced/demonstration-guided-skills.mdx
@@ -9,7 +9,7 @@ Human demonstrations provide powerful context for guiding agent behavior. By sho
The demonstration-guided workflow consists of three stages:
-1. **Record** - Capture a human performing the task via [VNC recording](/docs/cua/guide/advanced/vnc-recorder)
+1. **Record** - Capture a human performing the task via [VNC recording](/cua/guide/advanced/vnc-recorder)
2. **Process** - Convert the recording into semantic action traces with VLM captions
3. **Prompt** - Use the processed trajectory to guide agent execution
diff --git a/docs/content/docs/cua/guide/advanced/vnc-recorder.mdx b/docs/content/docs/cua/guide/advanced/vnc-recorder.mdx
index 109cbd8835..c46ec2be4a 100644
--- a/docs/content/docs/cua/guide/advanced/vnc-recorder.mdx
+++ b/docs/content/docs/cua/guide/advanced/vnc-recorder.mdx
@@ -61,7 +61,7 @@ cua skills read my-skill
### 1. Start a sandbox and open the VNC UI
-Start a sandbox using [Docker](/docs/cua/guide/get-started/self-hosted-sandboxes) or [Cua Cloud](/docs/cua/guide/get-started/quickstart). The VNC UI will be available at:
+Start a sandbox using [Docker](/cua/guide/get-started/set-up-sandbox) or [Cua Cloud](/cua/guide/get-started/set-up-sandbox). The VNC UI will be available at:
- **Docker**: `http://localhost:8006`
- **Cloud**: `https://{sandbox-name}.sandbox.cua.ai/vnc.html`
@@ -145,7 +145,7 @@ Recording data streams to disk in real-time via WebSocket, so the file is ready
| `autorecord=1` | Start recording when connection is established |
| `record_url=ws://...` | Stream recording to external WebSocket server |
-For more details on prompting agents with demonstrations, see [Demonstration-Guided Skills](/docs/cua/guide/advanced/demonstration-guided-skills).
+For more details on prompting agents with demonstrations, see [Demonstration-Guided Skills](/cua/guide/advanced/demonstration-guided-skills).
## Reference
diff --git a/docs/content/docs/cua/reference/agent-sdk/changelog.mdx b/docs/content/docs/cua/reference/agent-sdk/changelog.mdx
index 7eea1428f9..7a4019b688 100644
--- a/docs/content/docs/cua/reference/agent-sdk/changelog.mdx
+++ b/docs/content/docs/cua/reference/agent-sdk/changelog.mdx
@@ -366,7 +366,7 @@ Changelog:
- OpenAI providers - Added support for zero data retention
- Added Agent CLI for quick testing: `python -m agent.cli <model name>`
-[Breaking Changes](https://docs-woad-phi.vercel.app/home/agent-sdk/migration-guide#breaking-changes)
+**Breaking Changes**
- **Initialization:**
- `ComputerAgent` (v0.4.x) uses `model` as a string (e.g. "anthropic/claude-3-5-sonnet-20241022") instead of `LLM` and `AgentLoop` objects.
diff --git a/docs/content/docs/cua/reference/cloud-cli/index.mdx b/docs/content/docs/cua/reference/cloud-cli/index.mdx
index 31d627f550..e1daaed038 100644
--- a/docs/content/docs/cua/reference/cloud-cli/index.mdx
+++ b/docs/content/docs/cua/reference/cloud-cli/index.mdx
@@ -65,4 +65,4 @@ cua stop my-sandbox
## Next Steps
-- [Command Reference](/cua/reference/cli-playbook/commands) - Full list of available commands
+- [Command Reference](/cua/reference/cloud-cli/commands) - Full list of available commands
diff --git a/docs/content/docs/cua/reference/desktop-sandbox/linux-container/index.mdx b/docs/content/docs/cua/reference/desktop-sandbox/linux-container/index.mdx
new file mode 100644
index 0000000000..e385486f52
--- /dev/null
+++ b/docs/content/docs/cua/reference/desktop-sandbox/linux-container/index.mdx
@@ -0,0 +1,37 @@
+---
+title: Linux Container
+description: Docker containers running Linux desktops for Computer-Using Agents
+---
+
+Docker containers running Linux desktops with fast startup and low resource usage. Each container includes a pre-installed computer-server for remote control via HTTP API.
+
+## Available Containers
+
+| Container | Description |
+| --- | --- |
+| [Kasm](/cua/reference/desktop-sandbox/linux-container/kasm) | KasmWeb-based Ubuntu with XFCE desktop |
+| [XFCE](/cua/reference/desktop-sandbox/linux-container/xfce) | Vanilla XFCE, minimal dependencies |
+
+## Key Features
+
+- **Fast startup** — Containers start in seconds
+- **Low resource usage** — Minimal overhead compared to full VMs
+- **Docker-based** — Works anywhere Docker runs
+- **Filesystem snapshots** — Save state via `docker commit`
+
+## Quick Start
+
+```python
+from computer import Computer
+
+async with Computer(
+ os_type="linux",
+ provider_type="docker",
+ image="trycua/cua-xfce:latest",
+) as computer:
+ screenshot = await computer.interface.screenshot()
+```
+
+## Limitations
+
+Linux containers only support filesystem snapshots via `docker commit`, which saves the disk state but not running processes or memory. The container must be restarted after restoring.
diff --git a/docs/content/docs/cua/reference/desktop-sandbox/linux-container/meta.json b/docs/content/docs/cua/reference/desktop-sandbox/linux-container/meta.json
index acabd08737..37c26d401e 100644
--- a/docs/content/docs/cua/reference/desktop-sandbox/linux-container/meta.json
+++ b/docs/content/docs/cua/reference/desktop-sandbox/linux-container/meta.json
@@ -1,4 +1,4 @@
{
"title": "Linux Container",
- "pages": ["kasm", "xfce"]
+ "pages": ["---", "kasm", "xfce"]
}
diff --git a/docs/content/docs/cua/reference/desktop-sandbox/macos.mdx b/docs/content/docs/cua/reference/desktop-sandbox/macos.mdx
index 6b5df57166..cb7d3f0caf 100644
--- a/docs/content/docs/cua/reference/desktop-sandbox/macos.mdx
+++ b/docs/content/docs/cua/reference/desktop-sandbox/macos.mdx
@@ -7,10 +7,10 @@ macOS sandbox environments run native macOS virtual machines on Apple Silicon us
## Options
-| Option | Description | Best For |
-| ------------------------------------- | ---------------------------------------------- | --------------------------------- |
-| [Lume](/lume) | Native CLI for creating and managing macOS VMs | Direct VM management, development |
-| [Lumier](/lume/guide/advanced/lumier) | Docker wrapper around Lume | Containerized deployments |
+| Option | Description | Best For |
+| ------------------------------------------------------------- | ---------------------------------------------- | --------------------------------- |
+| [Lume](/lume/guide/getting-started/introduction) | Native CLI for creating and managing macOS VMs | Direct VM management, development |
+| [Lumier](/lume/guide/advanced/lumier) | Docker wrapper around Lume | Containerized deployments |
## Requirements
@@ -76,6 +76,6 @@ async with computer:
## Related Documentation
-- [Lume Documentation](/lume) - Full Lume CLI reference
+- [Lume Documentation](/lume/guide/getting-started/introduction) - Full Lume CLI reference
- [Lumier Documentation](/lume/guide/advanced/lumier) - Docker-based macOS VMs
-- [Unattended Setup](/lume/guide/advanced/unattended-setup) - Automate macOS VM configuration
+- [Unattended Setup](/lume/guide/fundamentals/unattended-setup) - Automate macOS VM configuration
diff --git a/docs/content/docs/cua/reference/desktop-sandbox/qemu-container/index.mdx b/docs/content/docs/cua/reference/desktop-sandbox/qemu-container/index.mdx
new file mode 100644
index 0000000000..45bd7b05d9
--- /dev/null
+++ b/docs/content/docs/cua/reference/desktop-sandbox/qemu-container/index.mdx
@@ -0,0 +1,39 @@
+---
+title: QEMU Container
+description: Full virtual machines running in Docker via QEMU/KVM for Computer-Using Agents
+---
+
+Full virtual machines running in Docker via QEMU/KVM. Complete OS isolation with support for Windows, Linux, and Android.
+
+## Available Containers
+
+| Container | OS | Description |
+| --- | --- | --- |
+| [Windows](/cua/reference/desktop-sandbox/qemu-container/windows) | Windows 11 | Windows desktop with KVM |
+| [Linux](/cua/reference/desktop-sandbox/qemu-container/linux) | Ubuntu 22.04 | Full Ubuntu VM |
+| [Android](/cua/reference/desktop-sandbox/qemu-container/android) | Android 11 | Android emulator |
+
+## Key Features
+
+- **Complete OS isolation** — Full virtual machines with dedicated kernels
+- **Windows support** — Run Windows 11 in Docker
+- **Memory snapshots** — Save and restore full VM state including running processes
+- **KVM acceleration** — Near-native performance on Linux hosts with KVM support
+
+## Requirements
+
+- Linux host with KVM support
+- Docker with `--device=/dev/kvm` access
+
+## Quick Start
+
+```python
+from computer import Computer
+
+async with Computer(
+ os_type="windows",
+ provider_type="docker",
+ image="trycua/cua-qemu-windows:latest",
+) as computer:
+ screenshot = await computer.interface.screenshot()
+```
diff --git a/docs/content/docs/cua/reference/desktop-sandbox/qemu-container/meta.json b/docs/content/docs/cua/reference/desktop-sandbox/qemu-container/meta.json
index 2d86ecef55..4d2d31eb39 100644
--- a/docs/content/docs/cua/reference/desktop-sandbox/qemu-container/meta.json
+++ b/docs/content/docs/cua/reference/desktop-sandbox/qemu-container/meta.json
@@ -1,4 +1,4 @@
{
"title": "QEMU Container",
- "pages": ["windows", "linux", "android"]
+ "pages": ["---", "windows", "linux", "android"]
}
diff --git a/docs/content/docs/cuabench/examples/custom-agent.mdx b/docs/content/docs/cuabench/examples/custom-agent.mdx
index 3873cb62f6..ad2c44ced1 100644
--- a/docs/content/docs/cuabench/examples/custom-agent.mdx
+++ b/docs/content/docs/cuabench/examples/custom-agent.mdx
@@ -572,6 +572,6 @@ anthropic>=0.20.0
## Next Steps
-- Build a [Universal Task](/cuabench/guide/examples/universal-task) with custom GUIs
+- Build a [Universal Task](/cuabench/examples/universal-task) with custom GUIs
- See the [Custom Agents Guide](/cuabench/guide/advanced/custom-agents) for more details
- Explore the [Adapters](/cuabench/guide/fundamentals/adapters) for benchmark integrations
diff --git a/docs/content/docs/cuabench/examples/universal-task.mdx b/docs/content/docs/cuabench/examples/universal-task.mdx
index d6d3c0fc40..6b709112f8 100644
--- a/docs/content/docs/cuabench/examples/universal-task.mdx
+++ b/docs/content/docs/cuabench/examples/universal-task.mdx
@@ -409,4 +409,4 @@ The same HTML GUI and task code runs everywhere.
- Learn about [Simulated Desktop](/cuabench/guide/fundamentals/simulated-desktop) for themed previews
- See [Universal GUI](/cuabench/guide/fundamentals/universal-gui) for the full API
-- Build a [Custom Agent](/cuabench/guide/examples/custom-agent) to solve tasks
+- Build a [Custom Agent](/cuabench/examples/custom-agent) to solve tasks
diff --git a/docs/content/docs/cuabench/guide/fundamentals/registry.mdx b/docs/content/docs/cuabench/guide/fundamentals/registry.mdx
index 35f62a8fd0..b0e55ae2c3 100644
--- a/docs/content/docs/cuabench/guide/fundamentals/registry.mdx
+++ b/docs/content/docs/cuabench/guide/fundamentals/registry.mdx
@@ -92,7 +92,7 @@ To contribute tasks to the registry:
4. Test locally with `cb interact tasks/your_task`
5. Submit a pull request to the main repository
-See [Creating Tasks](/cuabench/guide/examples/universal-task) for task development guidance.
+See [Creating Tasks](/cuabench/examples/universal-task) for task development guidance.
## Registry Location
diff --git a/docs/content/docs/cuabench/guide/fundamentals/universal-gui.mdx b/docs/content/docs/cuabench/guide/fundamentals/universal-gui.mdx
index 7c37477f11..49b042979e 100644
--- a/docs/content/docs/cuabench/guide/fundamentals/universal-gui.mdx
+++ b/docs/content/docs/cuabench/guide/fundamentals/universal-gui.mdx
@@ -73,4 +73,4 @@ The [Simulated Desktop](/cuabench/guide/fundamentals/simulated-desktop) renders
- **State management**: Expose game/app state via `window.__variables`
- **Cross-platform**: Works in Docker containers and simulated desktop
-See the [Create a Universal Task](/cuabench/guide/examples/universal-task) example for a complete walkthrough.
+See the [Create a Universal Task](/cuabench/examples/universal-task) example for a complete walkthrough.
diff --git a/docs/content/docs/cuabot/reference/changelog.mdx b/docs/content/docs/cuabot/reference/changelog.mdx
index 51a2247cb8..d386784e11 100644
--- a/docs/content/docs/cuabot/reference/changelog.mdx
+++ b/docs/content/docs/cuabot/reference/changelog.mdx
@@ -21,8 +21,8 @@ All notable changes to the Cua-Bot are documented here.
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.12 (2026-02-05)
@@ -31,8 +31,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.11 (2026-02-04)
@@ -40,8 +40,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.10 (2026-02-04)
@@ -49,8 +49,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.9 (2026-02-04)
@@ -59,8 +59,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.8 (2026-02-04)
@@ -69,8 +69,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.7 (2026-02-04)
@@ -78,8 +78,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.6 (2026-02-04)
@@ -88,8 +88,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.5 (2026-02-04)
@@ -99,8 +99,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.4 (2026-02-04)
@@ -108,8 +108,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.3 (2026-02-04)
@@ -119,8 +119,8 @@ Documentation
Documentation
-- [Getting Started](https://cua.ai/docs/cuabot/cuabot)
-- [Installation Guide](https://cua.ai/docs/cuabot/install)
+- [Getting Started](/cuabot/guide/getting-started/introduction)
+- [Installation Guide](/cuabot/guide/getting-started/installation)
### v1.0.2 (2026-02-04)
@@ -129,4 +129,4 @@ Documentation
Documentation
-See [cua.ai/docs/cuabot](https://cua.ai/docs/cuabot)
+See [Cua-Bot documentation](/cuabot/guide/getting-started/introduction)
diff --git a/docs/content/docs/lume/examples/openclaw/index.mdx b/docs/content/docs/lume/examples/openclaw/index.mdx
index 797842bd72..5df4b55776 100644
--- a/docs/content/docs/lume/examples/openclaw/index.mdx
+++ b/docs/content/docs/lume/examples/openclaw/index.mdx
@@ -5,7 +5,7 @@ description: Run OpenClaw messaging gateway in an isolated macOS VM with Lume
import { Callout } from 'fumadocs-ui/components/callout';
-Run [OpenClaw](https://openclaw.dev) in a headless macOS VM to create a unified messaging gateway that bridges WhatsApp, Telegram, iMessage, and more with AI agents.
+Run [OpenClaw](https://openclaw.ai) in a headless macOS VM to create a unified messaging gateway that bridges WhatsApp, Telegram, iMessage, and more with AI agents.
## Why run OpenClaw in a VM?
@@ -213,7 +213,7 @@ Keep the VM running by:
- Disabling sleep in **System Settings** → **Energy Saver**
- Using `caffeinate` if needed
-For true always-on operation, consider a dedicated Mac mini or a small VPS. See [VPS hosting](https://openclaw.dev/docs/vps-hosting) for options.
+For true always-on operation, consider a dedicated Mac mini or a small VPS.
## Troubleshooting
diff --git a/docs/package.json b/docs/package.json
index bbb9eb3f50..3a726a6ab1 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -13,7 +13,9 @@
"docs:generate:lume": "tsx ../scripts/docs-generators/lume.ts",
"docs:generate:python": "tsx ../scripts/docs-generators/python-sdk.ts",
"docs:generate:changelog": "tsx ../scripts/docs-generators/generate-changelog.ts",
- "docs:generate:versions": "tsx ../scripts/docs-generators/generate-versioned-docs.ts"
+ "docs:generate:versions": "tsx ../scripts/docs-generators/generate-versioned-docs.ts",
+ "docs:check-links": "tsx scripts/check-links.ts",
+ "docs:check-links:external": "tsx scripts/check-links.ts --external"
},
"dependencies": {
"@ai-sdk/anthropic": "^3.0.9",
@@ -48,6 +50,8 @@
"@types/node": "22.15.28",
"@types/react": "^19.1.6",
"@types/react-dom": "^19.1.5",
+ "fast-glob": "^3.3.3",
+ "next-validate-link": "^1.6.4",
"postcss": "^8.5.4",
"prettier": "^3.6.2",
"tailwindcss": "^4.1.8",
diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml
index 2585bd8705..379c4dfed7 100644
--- a/docs/pnpm-lock.yaml
+++ b/docs/pnpm-lock.yaml
@@ -102,6 +102,12 @@ importers:
'@types/react-dom':
specifier: ^19.1.5
version: 19.1.6(@types/[email protected])
+ fast-glob:
+ specifier: ^3.3.3
+ version: 3.3.3
+ next-validate-link:
+ specifier: ^1.6.4
+ version: 1.6.4
postcss:
specifier: ^8.5.4
version: 8.5.6
@@ -814,89 +820,105 @@ packages:
resolution: {integrity: sha512-excjX8DfsIcJ10x1Kzr4RcWe1edC9PquDRRPx3YVCvQv+U5p7Yin2s32ftzikXojb1PIFc/9Mt28/y+iRklkrw==}
cpu: [arm64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-bFI7xcKFELdiNCVov8e44Ia4u2byA+l3XtsAj+Q8tfCwO6BQ8iDojYdvoPMqsKDkuoOo+X6HZA0s0q11ANMQ8A==}
cpu: [arm]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-FMuvGijLDYG6lW+b/UvyilUWu5Ayu+3r2d1S8notiGCIyYU/76eig1UfMmkZ7vwgOrzKzlQbFSuQfgm7GYUPpA==}
cpu: [ppc64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-oVDbcR4zUC0ce82teubSm+x6ETixtKZBh/qbREIOcI3cULzDyb18Sr/Wcyx7NRQeQzOiHTNbZFF1UwPS2scyGA==}
cpu: [riscv64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-qmp9VrzgPgMoGZyPvrQHqk02uyjA0/QrTO26Tqk6l4ZV0MPWIW6LTkqOIov+J1yEu7MbFQaDpwdwJKhbJvuRxQ==}
cpu: [s390x]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-tJxiiLsmHc9Ax1bz3oaOYBURTXGIRDODBqhveVHonrHJ9/+k89qbLl0bcJns+e4t4rvaNBxaEZsFtSfAdquPrw==}
cpu: [x64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-FVQHuwx1IIuNow9QAbYUzJ+En8KcVm9Lk5+uGUQJHaZmMECZmOlix9HnH7n1TRkXMS0pGxIJokIVB9SuqZGGXw==}
cpu: [arm64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-+LpyBk7L44ZIXwz/VYfglaX/okxezESc6UxDSoyo2Ks6Jxc4Y7sGjpgU9s4PMgqgjj1gZCylTieNamqA1MF7Dg==}
cpu: [x64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-bKQzaJRY/bkPOXyKx5EVup7qkaojECG6NLYswgktOZjaXecSAeCWiZwwiFf3/Y+O1HrauiE3FVsGxFg8c24rZg==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [arm64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-9dLqsvwtg1uuXBGZKsxem9595+ujv0sJ6Vi8wcTANSFpwV/GONat5eCkzQo/1O6zRIkh0m/8+5BjrRr7jDUSZw==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [arm]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-7zznwNaqW6YtsfrGGDA6BRkISKAAE1Jo0QdpNYXNMHu2+0dTrPflTLNkpc8l7MUP5M16ZJcUvysVWWrMefZquA==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [ppc64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-51gJuLPTKa7piYPaVs8GmByo7/U7/7TZOq+cnXJIHZKavIRHAP77e3N2HEl3dgiqdD/w0yUfiJnII77PuDDFdw==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [riscv64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-nQtCk0PdKfho3eC5MrbQoigJ2gd1CgddUMkabUj+rBevs8tZ2cULOx46E7oyX+04WGfABgIwmMC0VqieTiR4jg==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [s390x]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-MEzd8HPKxVxVenwAa+JRPwEC7QFjoPWuS5NZnBt6B3pu7EG2Ge0id1oLHZpPJdn3OQK+BQDiw9zStiHBTJQQQQ==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [x64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-fprJR6GtRsMt6Kyfq44IsChVZeGN97gTD331weR1ex1c1rypDEABN6Tm2xa1wE6lYb5DdEnk03NZPqA7Id21yg==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [arm64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-Jg8wNT1MUzIvhBFxViqrEhWDGzqymo3sV7z7ZsaWbZNDLXRJZoRGrjulp60YYtV4wfY8VIKcWidjojlLcWrd8Q==}
engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0}
cpu: [x64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-OdWTEiVkY2PHwqkbBI8frFxQQFekHaSSkUIJkwzclWZe64O1X4UlUjqqqLaPbUpMOQk6FBu/HtlGXNblIs0huw==}
@@ -1019,24 +1041,28 @@ packages:
engines: {node: '>= 10'}
cpu: [arm64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-+ksWNrZrthisXuo9gd1XnjHRowCbMtl/YgMpbRvFeDEqEBd523YHPWpBuDjomod88U8Xliw5DHhekBC3EOOd9g==}
engines: {node: '>= 10'}
cpu: [arm64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-4WtJU5cRDxpEE44Ana2Xro1284hnyVpBb62lIpU5k85D8xXxatT+rXxBgPkc7C1XwkZMWpK5rXLXTh9PFipWsA==}
engines: {node: '>= 10'}
cpu: [x64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-HYlhqIP6kBPXalW2dbMTSuB4+8fe+j9juyxwfMwCe9kQPPeiyFn7NMjNfoFOfJ2eXkeQsoUGXg+O2SE3m4Qg2w==}
engines: {node: '>= 10'}
cpu: [x64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-EviG+43iOoBRZg9deGauXExjRphhuYmIOJ12b9sAPy0eQ6iwcPxfED2asb/s2/yiLYOdm37kPaiZu8uXSYPs0Q==}
@@ -1050,6 +1076,18 @@ packages:
cpu: [x64]
os: [win32]
+ '@nodelib/[email protected]':
+ resolution: {integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==}
+ engines: {node: '>= 8'}
+
+ '@nodelib/[email protected]':
+ resolution: {integrity: sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==}
+ engines: {node: '>= 8'}
+
+ '@nodelib/[email protected]':
+ resolution: {integrity: sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==}
+ engines: {node: '>= 8'}
+
'@opentelemetry/[email protected]':
resolution: {integrity: sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg==}
engines: {node: '>=8.0.0'}
@@ -1623,24 +1661,28 @@ packages:
engines: {node: '>= 10'}
cpu: [arm64]
os: [linux]
+ libc: [glibc]
'@tailwindcss/[email protected]':
resolution: {integrity: sha512-saScU0cmWvg/Ez4gUmQWr9pvY9Kssxt+Xenfx1LG7LmqjcrvBnw4r9VjkFcqmbBb7GCBwYNcZi9X3/oMda9sqQ==}
engines: {node: '>= 10'}
cpu: [arm64]
os: [linux]
+ libc: [musl]
'@tailwindcss/[email protected]':
resolution: {integrity: sha512-/G3ao/ybV9YEEgAXeEg28dyH6gs1QG8tvdN9c2MNZdUXYBaIY/Gx0N6RlJzfLy/7Nkdok4kaxKPHKJUlAaoTdA==}
engines: {node: '>= 10'}
cpu: [x64]
os: [linux]
+ libc: [glibc]
'@tailwindcss/[email protected]':
resolution: {integrity: sha512-LNr7X8fTiKGRtQGOerSayc2pWJp/9ptRYAa4G+U+cjw9kJZvkopav1AQc5HHD+U364f71tZv6XamaHKgrIoVzA==}
engines: {node: '>= 10'}
cpu: [x64]
os: [linux]
+ libc: [musl]
'@tailwindcss/[email protected]':
resolution: {integrity: sha512-d6ekQpopFQJAcIK2i7ZzWOYGZ+A6NzzvQ3ozBvWFdeyqfOZdYHU66g5yr+/HC4ipP1ZgWsqa80+ISNILk+ae/Q==}
@@ -1937,6 +1979,9 @@ packages:
resolution: {integrity: sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==}
engines: {node: '>=10'}
+ resolution: {integrity: sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==}
+
resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==}
@@ -1972,6 +2017,10 @@ packages:
resolution: {integrity: sha512-oP5VkATKlNwcgvxi0vM0p/D3n2C3EReYVX+DNYs5TjZFn/oQt2j+4sVJtSMr18pdRr8wjTcBl6LoV+FUwzPmNA==}
engines: {node: '>=18'}
+ resolution: {integrity: sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==}
+ engines: {node: '>=8'}
+
resolution: {integrity: sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==}
@@ -2449,6 +2498,11 @@ packages:
resolution: {integrity: sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==}
engines: {node: '>=12'}
+ resolution: {integrity: sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==}
+ engines: {node: '>=4'}
+ hasBin: true
+
resolution: {integrity: sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==}
@@ -2510,6 +2564,10 @@ packages:
resolution: {integrity: sha512-hIS4idWWai69NezIdRt2xFVofaF4j+6INOpJlVOLDO8zXGpUVEVzIYk12UUi2JzjEzWL3IOAxcTubgz9Po0yXw==}
engines: {node: '>= 18'}
+ resolution: {integrity: sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==}
+ engines: {node: '>=0.10.0'}
+
resolution: {integrity: sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==}
@@ -2519,6 +2577,10 @@ packages:
resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==}
+ resolution: {integrity: sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==}
+ engines: {node: '>=8.6.0'}
+
resolution: {integrity: sha512-vf6IHUX2SBcA+5/+4883dsIjpBTqmfBjmYiWK1savxQmFk4JfBMLa7ynTYOs1Rolp/T1betJxHiGD3g1Mn8lUQ==}
@@ -2528,6 +2590,9 @@ packages:
resolution: {integrity: sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==}
+ resolution: {integrity: sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==}
+
resolution: {integrity: sha512-CJ0HCB5tL5fYTEA7ToAq5+kTwd++Borf1/bifxd9iT70QcXr4MRrO3Llf8Ifs70q+SJcGHFtnIE/Nw6giCtECA==}
@@ -2543,6 +2608,10 @@ packages:
resolution: {integrity: sha512-FJqqoDBR00Mdj9ppamLa/Y7vxm+PRmNWA67N846RvsoYVMKB4q3y/de5PA7gUmRMYK/8CMz2GDZQmCRN1wBcWA==}
+ resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==}
+ engines: {node: '>=8'}
+
resolution: {integrity: sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg==}
engines: {node: '>= 0.8'}
@@ -2681,6 +2750,10 @@ packages:
resolution: {integrity: sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw==}
+ resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==}
+ engines: {node: '>= 6'}
+
resolution: {integrity: sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==}
engines: {node: '>= 0.4'}
@@ -2709,6 +2782,10 @@ packages:
resolution: {integrity: sha512-DKKrynuQRne0PNpEbzuEdHlYOMksHSUI8Zc9Unei5gTsMNA2/vMpoMz/yKba50pejK56qj98qM0SjYxAKi13gQ==}
engines: {node: ^12.22.0 || ^14.16.0 || ^16.0.0 || >=17.0.0}
+ resolution: {integrity: sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==}
+ engines: {node: '>=6.0'}
+
resolution: {integrity: sha512-3GKBOn+m2LX9iq+JC1064cSFprJY4jL1jCXTcpnfER5HYE2l/4EfWSGzkPa/ZDBmYI0ZOEj5VHV/eKnPGkHuOg==}
@@ -2877,12 +2954,28 @@ packages:
resolution: {integrity: sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==}
+ resolution: {integrity: sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==}
+ engines: {node: '>=0.10.0'}
+
+ resolution: {integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==}
+ engines: {node: '>=0.10.0'}
+
+ resolution: {integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==}
+ engines: {node: '>=0.10.0'}
+
resolution: {integrity: sha512-gyPJuv83bHMpocVYoqof5VDiZveEoGoFL8m3BXNb2VW8Xs+rz9kqO8LOQ5DH6EsuvilT1ApazU0pyl+ytbPtlw==}
resolution: {integrity: sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==}
+ resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==}
+ engines: {node: '>=0.12.0'}
+
resolution: {integrity: sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==}
engines: {node: '>=12'}
@@ -2913,6 +3006,10 @@ packages:
resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==}
+ resolution: {integrity: sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==}
+ hasBin: true
+
resolution: {integrity: sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==}
hasBin: true
@@ -2941,6 +3038,10 @@ packages:
resolution: {integrity: sha512-Ls993zuzfayK269Svk9hzpeGUKob/sIgZzyHYdjQoAdQetRKpOLj+k/QQQ/6Qi0Yz65mlROrfd+Ev+1+7dz9Kw==}
+ resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==}
+ engines: {node: '>=0.10.0'}
+
resolution: {integrity: sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==}
engines: {node: '>=6'}
@@ -3004,24 +3105,28 @@ packages:
engines: {node: '>= 12.0.0'}
cpu: [arm64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-jmUQVx4331m6LIX+0wUhBbmMX7TCfjF5FoOH6SD1CttzuYlGNVpA7QnrmLxrsub43ClTINfGSYyHe2HWeLl5CQ==}
engines: {node: '>= 12.0.0'}
cpu: [arm64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-piWx3z4wN8J8z3+O5kO74+yr6ze/dKmPnI7vLqfSqI8bccaTGY5xiSGVIJBDd5K5BHlvVLpUB3S2YCfelyJ1bw==}
engines: {node: '>= 12.0.0'}
cpu: [x64]
os: [linux]
+ libc: [glibc]
resolution: {integrity: sha512-rRomAK7eIkL+tHY0YPxbc5Dra2gXlI63HL+v1Pdi1a3sC+tJTcFrHX+E86sulgAXeI7rSzDYhPSeHHjqFhqfeQ==}
engines: {node: '>= 12.0.0'}
cpu: [x64]
os: [linux]
+ libc: [musl]
resolution: {integrity: sha512-mSL4rqPi4iXq5YVqzSsJgMVFENoa4nGTT/GjO2c0Yl9OuQfPsIfncvLrEW6RbbB24WtZ3xP/2CCmI3tNkNV4oA==}
@@ -3193,6 +3298,10 @@ packages:
resolution: {integrity: sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g==}
engines: {node: '>=18'}
+ resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==}
+ engines: {node: '>= 8'}
+
resolution: {integrity: sha512-UlIZrRariB11TY1RtTgUWp65tphtBv4CSq7vyS2ZZ2TgoMjs2nloq+wFqxiwcxlhHUvs7DPGgMjs2aeQxz5h9g==}
@@ -3400,6 +3509,10 @@ packages:
resolution: {integrity: sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==}
+ resolution: {integrity: sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==}
+ engines: {node: '>=8.6'}
+
resolution: {integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==}
engines: {node: '>= 0.6'}
@@ -3473,6 +3586,9 @@ packages:
react: ^16.8 || ^17 || ^18 || ^19 || ^19.0.0-rc
react-dom: ^16.8 || ^17 || ^18 || ^19 || ^19.0.0-rc
+ resolution: {integrity: sha512-wR/VKyJlaTbUT5k1uujEnk6O616YtWGt52s9FJa3tRCQ2qL2TGFTAklXJ0QdX1NTAEeP6rGFOTtHEDwveFrc2g==}
+
resolution: {integrity: sha512-3mBRJyPxT4LOxAJI6IsXeFtKfiJUbjCLgvXO02fV8Wy/lIhPvP94Fe7dGhUgHXcQy4sSuYwQNcOLhIfOm0rL0A==}
engines: {node: '>=20.9.0'}
@@ -3606,6 +3722,10 @@ packages:
resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==}
+ resolution: {integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==}
+ engines: {node: '>=8.6'}
+
resolution: {integrity: sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==}
engines: {node: '>=12'}
@@ -3710,6 +3830,9 @@ packages:
resolution: {integrity: sha512-4EK3+xJl8Ts67nLYNwqw/dsFVnCf+qR7RgXSK9jEEm9unao3njwMDdmsdvoKBKHzxd7tCYz5e5M+SnMjdtXGQQ==}
engines: {node: '>=0.6'}
+ resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==}
+
resolution: {integrity: sha512-tYC1Q1hgyRuHgloV/YXs2w15unPVh8qfu/qCTfhTYamaw7fyhumKa2yGpdSo87vY32rIclj+4fWYQXUMs9EHvg==}
@@ -3929,6 +4052,10 @@ packages:
resolution: {integrity: sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==}
engines: {node: '>= 4'}
+ resolution: {integrity: sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==}
+ engines: {iojs: '>=1.0.0', node: '>=0.10.0'}
+
resolution: {integrity: sha512-IXgzBWvWQwE6PrDI05OvmXUIruQTcoMDzRsOd5CDvHCVLcLHMTSYvOK5Cm46kWqlV3yAbuSpBZdJ5oP5OUoStg==}
@@ -3939,6 +4066,9 @@ packages:
resolution: {integrity: sha512-nLTrUKm2UyiL7rlhapu/Zl45FwNgkZGaCpZbIHajDYgwlJCOzLSk+cIPAnsEqV955GjILJnKbdQC1nVPz+gAYQ==}
engines: {node: '>= 18'}
+ resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==}
+
resolution: {integrity: sha512-PdhdWy89SiZogBLaw42zdeqtRJ//zFd2PgQavcICDUgJT5oW10QCRKbJ6bg4r0/UY2M6BWd5tkxuGFRvCkgfHQ==}
@@ -3965,6 +4095,10 @@ packages:
resolution: {integrity: sha512-49oNpRjWRvnU8NyGVmUaYG4jtTkNonFZI86MmGRDqBphEK2EXT9gdEUoQPZhuBM8yWHxCWbobltqYO5M4XrUvQ==}
+ resolution: {integrity: sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==}
+ engines: {node: '>=4'}
+
resolution: {integrity: sha512-6aU+Rwsezw7VR8/nyvKTx8QpWH9FrcYiXXlqC4z5d5XQBDRqtbfsRjnwGyqbi3gddNtWHuEk9OANUotL26qKUw==}
@@ -4050,6 +4184,9 @@ packages:
resolution: {integrity: sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg==}
engines: {node: '>= 10.x'}
+ resolution: {integrity: sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==}
+
resolution: {integrity: sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==}
engines: {node: '>= 0.8'}
@@ -4065,6 +4202,10 @@ packages:
resolution: {integrity: sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==}
+ resolution: {integrity: sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==}
+ engines: {node: '>=0.10.0'}
+
resolution: {integrity: sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==}
engines: {node: '>=8'}
@@ -4126,6 +4267,10 @@ packages:
resolution: {integrity: sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==}
engines: {node: '>=12.0.0'}
+ resolution: {integrity: sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==}
+ engines: {node: '>=8.0'}
+
resolution: {integrity: sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==}
engines: {node: '>=0.6'}
@@ -4209,9 +4354,6 @@ packages:
resolution: {integrity: sha512-u9njyyfEh43npf1M+yGKDGVPbY/JWEemg5nH05ncKPfi+kBbKBJoTdsogMu33uhytuLlv9y0O7GH7fEdwLdLQw==}
- resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==}
-
resolution: {integrity: sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==}
@@ -4236,9 +4378,6 @@ packages:
resolution: {integrity: sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg==}
- resolution: {integrity: sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==}
-
resolution: {integrity: sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ==}
@@ -5337,6 +5476,18 @@ snapshots:
optional: true
+ '@nodelib/[email protected]':
+ dependencies:
+ '@nodelib/fs.stat': 2.0.5
+ run-parallel: 1.2.0
+
+ '@nodelib/[email protected]': {}
+
+ '@nodelib/[email protected]':
+ dependencies:
+ '@nodelib/fs.scandir': 2.1.5
+ fastq: 1.20.1
+
'@opentelemetry/[email protected]': {}
'@orama/[email protected]': {}
@@ -6297,6 +6448,10 @@ snapshots:
+ dependencies:
+ sprintf-js: 1.0.3
+
@@ -6346,6 +6501,10 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ fill-range: 7.1.1
+
dependencies:
base64-js: 1.5.1
@@ -6848,6 +7007,8 @@ snapshots:
+
dependencies:
'@types/estree': 1.0.8
@@ -6972,18 +7133,34 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ is-extendable: 0.1.1
+
+ dependencies:
+ '@nodelib/fs.stat': 2.0.5
+ '@nodelib/fs.walk': 1.2.8
+ glob-parent: 5.1.2
+ merge2: 1.4.1
+ micromatch: 4.0.8
+
+ dependencies:
+ reusify: 1.1.0
+
dependencies:
format: 0.2.2
@@ -6994,6 +7171,10 @@ snapshots:
+ dependencies:
+ to-regex-range: 5.0.1
+
dependencies:
debug: 2.6.9
@@ -7165,6 +7346,10 @@ snapshots:
+ dependencies:
+ is-glob: 4.0.3
+
@@ -7197,6 +7382,13 @@ snapshots:
+ dependencies:
+ js-yaml: 3.14.2
+ kind-of: 6.0.3
+ section-matter: 1.0.0
+ strip-bom-string: 1.0.0
+
@@ -7448,10 +7640,20 @@ snapshots:
+
+
+ dependencies:
+ is-extglob: 2.1.1
+
+
@@ -7472,6 +7674,11 @@ snapshots:
+ dependencies:
+ argparse: 1.0.10
+ esprima: 4.0.1
+
dependencies:
argparse: 2.0.1
@@ -7497,6 +7704,8 @@ snapshots:
+
@@ -7641,8 +7850,8 @@ snapshots:
dependencies:
'@types/mdast': 4.0.4
escape-string-regexp: 5.0.0
- unist-util-is: 6.0.0
- unist-util-visit-parents: 6.0.1
+ unist-util-is: 6.0.1
+ unist-util-visit-parents: 6.0.2
dependencies:
@@ -7799,7 +8008,7 @@ snapshots:
dependencies:
'@types/mdast': 4.0.4
- unist-util-is: 6.0.0
+ unist-util-is: 6.0.1
dependencies:
@@ -7864,6 +8073,8 @@ snapshots:
+
dependencies:
'@braintree/sanitize-url': 7.1.1
@@ -8328,6 +8539,11 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ braces: 3.0.3
+ picomatch: 2.3.1
+
@@ -8378,6 +8594,18 @@ snapshots:
react: 19.2.0
react-dom: 19.2.0([email protected])
+ dependencies:
+ gray-matter: 4.0.3
+ picocolors: 1.1.1
+ remark: 15.0.1
+ remark-gfm: 4.0.1
+ remark-mdx: 3.1.1
+ tinyglobby: 0.2.15
+ unist-util-visit: 5.0.0
+ transitivePeerDependencies:
+ - supports-color
+
dependencies:
'@next/env': 16.0.7
@@ -8509,6 +8737,8 @@ snapshots:
+
@@ -8632,6 +8862,8 @@ snapshots:
dependencies:
side-channel: 1.1.0
+
@@ -8964,6 +9196,8 @@ snapshots:
+
@@ -8983,6 +9217,10 @@ snapshots:
transitivePeerDependencies:
- supports-color
+ dependencies:
+ queue-microtask: 1.2.3
+
@@ -9005,6 +9243,11 @@ snapshots:
dependencies:
compute-scroll-into-view: 3.1.1
+ dependencies:
+ extend-shallow: 2.0.1
+ kind-of: 6.0.3
+
@@ -9167,6 +9410,8 @@ snapshots:
+
@@ -9210,6 +9455,8 @@ snapshots:
character-entities-html4: 2.1.0
character-entities-legacy: 3.0.0
+
@@ -9263,6 +9510,10 @@ snapshots:
fdir: 6.5.0([email protected])
picomatch: 4.0.3
+ dependencies:
+ is-number: 7.0.0
+
@@ -9351,10 +9602,6 @@ snapshots:
dependencies:
'@types/unist': 2.0.11
- dependencies:
- '@types/unist': 3.0.3
-
dependencies:
'@types/unist': 3.0.3
@@ -9389,11 +9636,6 @@ snapshots:
'@types/unist': 2.0.11
unist-util-is: 5.2.1
- dependencies:
- '@types/unist': 3.0.3
- unist-util-is: 6.0.0
-
dependencies:
'@types/unist': 3.0.3
@@ -9408,8 +9650,8 @@ snapshots:
dependencies:
'@types/unist': 3.0.3
- unist-util-is: 6.0.0
- unist-util-visit-parents: 6.0.1
+ unist-util-is: 6.0.1
+ unist-util-visit-parents: 6.0.2
diff --git a/docs/scripts/check-links.ts b/docs/scripts/check-links.ts
new file mode 100644
index 0000000000..ba339b7985
--- /dev/null
+++ b/docs/scripts/check-links.ts
@@ -0,0 +1,86 @@
+#!/usr/bin/env npx tsx
+
+/**
+ * Documentation Link Checker
+ *
+ * Uses next-validate-link (by the Fumadocs author) to validate all internal
+ * links across MDX documentation files. Builds the valid URL map from the
+ * content directory and validates links using remark-based MDX parsing.
+ *
+ * Usage:
+ * pnpm docs:check-links # Check internal links
+ * pnpm docs:check-links:external # Also check external links
+ */
+
+import { readFiles, validateFiles, printErrors, type ScanResult } from "next-validate-link";
+import * as path from "path";
+import fg from "fast-glob";
+
+const DOCS_DIR = path.resolve(__dirname, "..");
+const CONTENT_DIR = path.join(DOCS_DIR, "content/docs");
+
+/**
+ * Build the ScanResult (valid URL map) directly from content files.
+ * This is more reliable than scanURLs for catch-all routes.
+ */
+function buildScannedUrls(): ScanResult {
+ const urls = new Map<string, {}>();
+ const mdxFiles = fg.sync("**/*.mdx", { cwd: CONTENT_DIR });
+
+ for (const file of mdxFiles) {
+ const slug = file
+ .replace(/\.mdx$/, "")
+ .replace(/\/index$/, "");
+ urls.set(`/${slug}`, {});
+ }
+
+ // Also add the root
+ urls.set("/", {});
+
+ return { urls, fallbackUrls: [] };
+}
+
+function pathToUrl(filePath: string): string | undefined {
+ const slug = filePath
+ .replace(/^content\/docs\//, "")
+ .replace(/\.mdx$/, "")
+ .replace(/\/index$/, "");
+ return `/${slug}`;
+}
+
+async function main() {
+ const args = process.argv.slice(2);
+ const checkExternal = args.includes("--external");
+
+ const scanned = buildScannedUrls();
+
+ // Read all MDX content files
+ const files = await readFiles("content/docs/**/*.mdx", { pathToUrl });
+
+ // Validate all links in the MDX files
+ const results = await validateFiles(files, {
+ scanned,
+ checkExternal,
+ // Fumadocs resolves relative MDX links at runtime, skip them here
+ checkRelativePaths: false,
+ checkRelativeUrls: false,
+ pathToUrl,
+ whitelist: (url: string) => {
+ const pathname = url.split(/[#?]/)[0];
+ const ext = path.extname(pathname).toLowerCase();
+ const staticExts = new Set([
+ ".png", ".jpg", ".jpeg", ".gif", ".svg", ".ico",
+ ".webp", ".avif", ".mp4", ".webm", ".pdf",
+ ".css", ".js", ".woff", ".woff2", ".ttf", ".eot",
+ ]);
+ return staticExts.has(ext);
+ },
+ });
+
+ printErrors(results, true);
+}
+
+main().catch((err) => {
+ console.error("Fatal error:", err);
+ process.exit(1);
+});
diff --git a/docs/src/components/custom-header.tsx b/docs/src/components/custom-header.tsx
index 7ee108bdcc..3a97e7b9a0 100644
--- a/docs/src/components/custom-header.tsx
+++ b/docs/src/components/custom-header.tsx
@@ -59,8 +59,8 @@ const docsSites = [
},
{
name: 'Examples',
- href: '/cuabench/guide/examples/custom-agent',
- prefix: '/cuabench/guide/examples',
+ href: '/cuabench/examples/custom-agent',
+ prefix: '/cuabench/examples',
},
{
name: 'Reference',