From 1dd857f6a6a43b0f47999ec0b8d9021e1c009909 Mon Sep 17 00:00:00 2001 From: Vincent Koc Date: Thu, 19 Mar 2026 10:28:44 -0700 Subject: [PATCH] docs: add API key prereq, first-message step, fix landing page quick start --- docs/index.md | 12 +++++++---- docs/start/getting-started.md | 39 +++++++++++++---------------------- 2 files changed, 22 insertions(+), 29 deletions(-) diff --git a/docs/index.md b/docs/index.md index 25162bc9676..270f0835287 100644 --- a/docs/index.md +++ b/docs/index.md @@ -106,15 +106,19 @@ The Gateway is the single source of truth for sessions, routing, and channel con openclaw onboard --install-daemon ``` - + + Open the Control UI in your browser and send a message: + ```bash - openclaw channels login - openclaw gateway --port 18789 + openclaw dashboard ``` + + Or connect a channel ([Telegram](/channels/telegram) is fastest) and chat from your phone. + -Need the full install and dev setup? See [Quick start](/start/quickstart). +Need the full install and dev setup? See [Getting Started](/start/getting-started). ## Dashboard diff --git a/docs/start/getting-started.md b/docs/start/getting-started.md index bd3f554cdc4..fa719093739 100644 --- a/docs/start/getting-started.md +++ b/docs/start/getting-started.md @@ -20,9 +20,11 @@ Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui). ## Prereqs - Node 24 recommended (Node 22 LTS, currently `22.16+`, still supported for compatibility) +- An API key from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you for this Check your Node version with `node --version` if you are unsure. +Windows users: WSL2 is strongly recommended. See [Windows](/platforms/windows). ## Quick setup (CLI) @@ -73,34 +75,21 @@ Check your Node version with `node --version` if you are unsure. ```bash openclaw dashboard ``` + + If the Control UI loads, your Gateway is ready. + + + + The fastest way to chat is directly in the Control UI browser tab. + Type a message and you should get an AI reply. + + Want to chat from a messaging app instead? The fastest channel setup + is usually [Telegram](/channels/telegram) (just a bot token, no QR + pairing). See [Channels](/channels) for all options. + - -If the Control UI loads, your Gateway is ready for use. - - -## Optional checks and extras - - - - Useful for quick tests or troubleshooting. - - ```bash - openclaw gateway --port 18789 - ``` - - - - Requires a configured channel. - - ```bash - openclaw message send --target +15555550123 --message "Hello from OpenClaw" - ``` - - - - ## Useful environment variables If you run OpenClaw as a service account or want custom config/state locations: