From 116bc2a0f0c478bbce8042d7b295a601c0e5d654 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Wed, 3 Jun 2026 16:09:14 -0700 Subject: [PATCH] docs: surface Windows Hub across docs --- README.md | 7 ++++--- docs/concepts/features.md | 4 ++-- docs/help/faq-first-run.md | 3 ++- docs/help/faq.md | 13 +++++++++---- docs/platforms/index.md | 10 +++++++--- docs/start/docs-directory.md | 2 +- docs/start/hubs.md | 2 +- docs/start/openclaw.md | 2 +- docs/start/wizard.md | 5 +++-- 9 files changed, 30 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 9de37c85cbd1..e34dda3f4858 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,8 @@ Supported channels include: WhatsApp, Telegram, Slack, Discord, Google Chat, Sig New install? Start here: [Getting started](https://docs.openclaw.ai/start/getting-started) Preferred setup: run `openclaw onboard` in your terminal. -OpenClaw Onboard guides you step by step through setting up the gateway, workspace, channels, and skills. It is the recommended CLI setup path and works on **macOS, Linux, and Windows (via WSL2; strongly recommended)**. +OpenClaw Onboard guides you step by step through setting up the gateway, workspace, channels, and skills. It is the recommended CLI setup path and works on **macOS, Linux, and Windows**. +Windows desktop users can start with the native [Windows Hub](https://docs.openclaw.ai/platforms/windows) companion app for setup, tray status, chat, node mode, and local MCP mode. Works with npm, pnpm, or bun. ## Sponsors @@ -164,7 +165,7 @@ Run `openclaw doctor` to surface risky/misconfigured DM policies. - **[Voice Wake](https://docs.openclaw.ai/nodes/voicewake) + [Talk Mode](https://docs.openclaw.ai/nodes/talk)** — wake words on macOS/iOS and continuous voice on Android (ElevenLabs + system TTS fallback). - **[Live Canvas](https://docs.openclaw.ai/platforms/mac/canvas)** — agent-driven visual workspace with [A2UI](https://docs.openclaw.ai/platforms/mac/canvas#canvas-a2ui). - **[First-class tools](https://docs.openclaw.ai/tools)** — browser, canvas, nodes, cron, sessions, and Discord/Slack actions. -- **[Companion apps](https://docs.openclaw.ai/platforms/macos)** — macOS menu bar app + iOS/Android [nodes](https://docs.openclaw.ai/nodes). +- **[Companion apps](https://docs.openclaw.ai/platforms)** — Windows Hub, macOS menu bar app, and iOS/Android [nodes](https://docs.openclaw.ai/nodes). - **[Onboarding](https://docs.openclaw.ai/start/wizard) + [skills](https://docs.openclaw.ai/tools/skills)** — onboarding-driven setup with bundled/managed/workspace skills. ## Security model (important) @@ -185,7 +186,7 @@ Run `openclaw doctor` to surface risky/misconfigured DM policies. - New here: [Getting started](https://docs.openclaw.ai/start/getting-started), [Onboarding](https://docs.openclaw.ai/start/wizard), [Updating](https://docs.openclaw.ai/install/updating) - Channel setup: [Channels index](https://docs.openclaw.ai/channels), [WhatsApp](https://docs.openclaw.ai/channels/whatsapp), [Telegram](https://docs.openclaw.ai/channels/telegram), [Discord](https://docs.openclaw.ai/channels/discord), [Slack](https://docs.openclaw.ai/channels/slack) -- Apps + nodes: [macOS](https://docs.openclaw.ai/platforms/macos), [iOS](https://docs.openclaw.ai/platforms/ios), [Android](https://docs.openclaw.ai/platforms/android), [Nodes](https://docs.openclaw.ai/nodes) +- Apps + nodes: [Windows Hub](https://docs.openclaw.ai/platforms/windows), [macOS](https://docs.openclaw.ai/platforms/macos), [iOS](https://docs.openclaw.ai/platforms/ios), [Android](https://docs.openclaw.ai/platforms/android), [Nodes](https://docs.openclaw.ai/nodes) - Config + security: [Configuration](https://docs.openclaw.ai/gateway/configuration), [Security](https://docs.openclaw.ai/gateway/security), [Exposure runbook](https://docs.openclaw.ai/gateway/security/exposure-runbook), [Sandboxing](https://docs.openclaw.ai/gateway/sandboxing) - Remote + web: [Gateway](https://docs.openclaw.ai/gateway), [Remote access](https://docs.openclaw.ai/gateway/remote), [Tailscale](https://docs.openclaw.ai/gateway/tailscale), [Web surfaces](https://docs.openclaw.ai/web) - Tools + automation: [Tools](https://docs.openclaw.ai/tools), [Skills](https://docs.openclaw.ai/tools/skills), [Cron jobs](https://docs.openclaw.ai/automation/cron-jobs), [Webhooks](https://docs.openclaw.ai/automation/webhook), [Gmail Pub/Sub](https://docs.openclaw.ai/automation/gmail-pubsub) diff --git a/docs/concepts/features.md b/docs/concepts/features.md index b3cfa5da0796..ee61e7a8b840 100644 --- a/docs/concepts/features.md +++ b/docs/concepts/features.md @@ -20,8 +20,8 @@ title: "Features" Images, audio, video, documents, and image/video generation. - - Web Control UI and macOS companion app. + + Windows Hub, Web Control UI, macOS app, and mobile nodes. iOS and Android nodes with pairing, voice/chat, and rich device commands. diff --git a/docs/help/faq-first-run.md b/docs/help/faq-first-run.md index 5a5d3c4ea4a1..8d2f8cc588ae 100644 --- a/docs/help/faq-first-run.md +++ b/docs/help/faq-first-run.md @@ -856,7 +856,8 @@ and troubleshooting see the main [FAQ](/help/faq). - **Recommended:** 2GB RAM or more if you run multiple channels, browser automation, or media tools. - **OS:** Ubuntu LTS or another modern Debian/Ubuntu. - If you are on Windows, **WSL2 is the easiest VM style setup** and has the best tooling + If you are on Windows, use **Windows Hub** for desktop setup, or WSL2 when + you specifically want a Linux-style Gateway VM with broad tooling compatibility. See [Windows](/platforms/windows), [VPS hosting](/vps). If you are running macOS in a VM, see [macOS VM](/install/macos-vm). diff --git a/docs/help/faq.md b/docs/help/faq.md index 418e557d72b0..ea1ac663d1c1 100644 --- a/docs/help/faq.md +++ b/docs/help/faq.md @@ -1652,9 +1652,14 @@ lives on the [Models FAQ](/help/faq-models). - There are **two Windows install modes**: + There are **three Windows install modes**: - **1) WSL2 (recommended):** the Gateway runs inside Linux. + **1) Windows Hub local setup:** the native app manages a local app-owned WSL Gateway. + + Open **OpenClaw Companion** from the Start menu or tray, then use + **Gateway Setup** or the Connections tab. + + **2) Manual WSL2 Gateway:** the Gateway runs inside Linux. Open PowerShell, enter WSL, then restart: @@ -1670,7 +1675,7 @@ lives on the [Models FAQ](/help/faq-models). openclaw gateway run ``` - **2) Native Windows (not recommended):** the Gateway runs directly in Windows. + **3) Native Windows CLI/Gateway:** the Gateway runs directly in Windows. Open PowerShell and run: @@ -1685,7 +1690,7 @@ lives on the [Models FAQ](/help/faq-models). openclaw gateway run ``` - Docs: [Windows (WSL2)](/platforms/windows), [Gateway service runbook](/gateway). + Docs: [Windows](/platforms/windows), [Gateway service runbook](/gateway). diff --git a/docs/platforms/index.md b/docs/platforms/index.md index ffdf38f0586d..4a073193998f 100644 --- a/docs/platforms/index.md +++ b/docs/platforms/index.md @@ -10,9 +10,11 @@ OpenClaw core is written in TypeScript. **Node is the recommended runtime**. Bun is not recommended for the Gateway — known issues with WhatsApp and Telegram channels; see [Bun (experimental)](/install/bun) for details. -Companion apps exist for macOS (menu bar app) and mobile nodes (iOS/Android). Windows and -Linux companion apps are planned, but the Gateway is fully supported today. -Native companion apps for Windows are also planned; the Gateway is recommended via WSL2. +Companion apps exist for Windows Hub, macOS (menu bar app), and mobile nodes +(iOS/Android). Linux companion apps are planned, but the Gateway is fully +supported today. On Windows, choose Windows Hub for the desktop app, native +PowerShell install for terminal-first use, or WSL2 for the most +Linux-compatible Gateway runtime. ## Choose your OS @@ -35,6 +37,7 @@ Native companion apps for Windows are also planned; the Gateway is recommended v ## Common links - Install guide: [Getting Started](/start/getting-started) +- Windows Hub: [Windows](/platforms/windows) - Gateway runbook: [Gateway](/gateway) - Gateway configuration: [Configuration](/gateway/configuration) - Service status: `openclaw gateway status` @@ -57,5 +60,6 @@ The service target depends on OS: ## Related - [Install overview](/install) +- [Windows Hub](/platforms/windows) - [macOS app](/platforms/macos) - [iOS app](/platforms/ios) diff --git a/docs/start/docs-directory.md b/docs/start/docs-directory.md index 6179ace1b229..328d6fef86e5 100644 --- a/docs/start/docs-directory.md +++ b/docs/start/docs-directory.md @@ -51,7 +51,7 @@ For a complete map of the docs, see [Docs hubs](/start/hubs). - [macOS app](/platforms/macos) - [iOS app](/platforms/ios) - [Android app](/platforms/android) -- [Windows (WSL2)](/platforms/windows) +- [Windows Hub](/platforms/windows) - [Linux app](/platforms/linux) ## Operations and safety diff --git a/docs/start/hubs.md b/docs/start/hubs.md index 6b414b8c8969..fe4e5bd0b883 100644 --- a/docs/start/hubs.md +++ b/docs/start/hubs.md @@ -135,7 +135,7 @@ Use these hubs to discover every page, including deep dives and reference docs t - [macOS](/platforms/macos) - [iOS](/platforms/ios) - [Android](/platforms/android) -- [Windows (WSL2)](/platforms/windows) +- [Windows Hub](/platforms/windows) - [Linux](/platforms/linux) - [Web surfaces](/web) diff --git a/docs/start/openclaw.md b/docs/start/openclaw.md index deb156c8b2b6..7f4364c03d2a 100644 --- a/docs/start/openclaw.md +++ b/docs/start/openclaw.md @@ -235,7 +235,7 @@ Logs live under `/tmp/openclaw/` (default: `openclaw-YYYY-MM-DD.log`). - macOS menu bar companion: [OpenClaw macOS app](/platforms/macos) - iOS node app: [iOS app](/platforms/ios) - Android node app: [Android app](/platforms/android) -- Windows status: [Windows (WSL2)](/platforms/windows) +- Windows Hub: [Windows](/platforms/windows) - Linux status: [Linux app](/platforms/linux) - Security: [Security](/gateway/security) diff --git a/docs/start/wizard.md b/docs/start/wizard.md index eb15bd860750..3a97e17307d4 100644 --- a/docs/start/wizard.md +++ b/docs/start/wizard.md @@ -7,8 +7,9 @@ title: "Onboarding (CLI)" sidebarTitle: "Onboarding: CLI" --- -CLI onboarding is the **recommended** way to set up OpenClaw on macOS, -Linux, or Windows (via WSL2; strongly recommended). +CLI onboarding is the **recommended** terminal setup path for OpenClaw on +macOS, Linux, or Windows. Windows desktop users can also start with +[Windows Hub](/platforms/windows). It configures a local Gateway or a remote Gateway connection, plus channels, skills, and workspace defaults in one guided flow.