vrr/openclaw
2
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-10-03 09:39:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 30
openclaw/docs/start/docs-directory.md
Vincent Koc 11f454ee82
docs(start): repair the first-run path from landing page to first channel (#140390) 
Walks the new reader path end to end and fixes each step where the docs
sent the reader somewhere the previous step had not prepared.

Landing page (docs/index.md): the Quick start installed with npm and then
ran `openclaw onboard --install-daemon`, which selects the classic wizard
(onboarding-overview.md), so the landing reader never saw the Quick start
and Custom setup choice that Getting Started narrates. It now uses the
installer script that install/index.md calls "Recommended", names which
wizard that opens, and adds the missing Gateway service step. The mobile
hub card "Get started" pointed at `/`, and the "Channels" card pointed at
one channel page while promising the catalog; both now point at the hub
they describe.

Install page (docs/install/index.md): "Verify the install" ended the page
with no route onward. Adds a next-step card group to Getting started and
to the channel hub. docs/install/node.md pointed "installer script" at the
alternative-methods anchor instead of the installer script section.

Getting Started (docs/start/getting-started.md): Step 2 left the Gateway
in the foreground and buried "Ctrl+C, then `openclaw gateway install`" in
prose, while Steps 3 and 4 assumed a running background Gateway. That is
now its own numbered step between onboarding and verification.

Channel hub (docs/channels/index.md): the "fastest setup is usually
Telegram" guidance sat at the bottom, below the catalog and a long group
introductions explanation, and the page carried no `openclaw channels add`
example. Both now sit above the 31-entry catalog.

Telegram (docs/channels/telegram.md): quick setup showed a JSON5 block
with no file path and no `openclaw channels add`, told the reader to run
`openclaw pairing list` without first sending the bot a message, and
started a second foreground Gateway that conflicts with the service the
Getting Started path installs. Step 2 now names `~/.openclaw/openclaw.json`
and leads with `openclaw channels add --channel telegram --token <token>`.
Restart and pairing are separate steps, the restart uses
`openclaw gateway restart` with `openclaw gateway` named as the
no-service case, and pairing starts by messaging the bot. The opening
line now says what the page is for.

macOS onboarding (docs/start/onboarding.md): the first three steps were
images with empty alt text. Each now says what dialog appears and which
button to click, and read_when addresses first-run readers rather than
the people implementing the flow.

First-run FAQ (docs/help/faq-first-run.md): the install answer ran the
installer and then onboarding again, the "what does onboarding do" answer
described the classic 8-step wizard as the default, install and
onboarding answers sat below heartbeat and exec-approval answers, the
provider-add command disagreed with the wizard pages, and the "I am
stuck" link landed on a heading rather than the accordion.

Also trims duplicated Quick start prose from onboarding-overview.md,
names the WhatsApp plugin prerequisite in openclaw.md, repairs the
localhost dashboard link and the install entries in hubs.md, cuts the
19-item "Start here" list in docs-directory.md, and splits the
single-instruction sentences named by the STE findings in telegram.md,
why-openclaw.md, teams.md, setup.md, and wizard-cli-automation.md.

Closes audit findings: r3-0936, r3-0937, r3-0938, r3-0939, r3-0940,
r3-0941, r3-0942, r3-0943, r3-0944, r3-0945, r3-0946, r3-0947, r3-0948,
r3-0949, r3-0950, r3-0951, r3-0952, r3-0953, r3-0954, r3-0955, r3-0956,
r3-0958, r3-0959, r3-0962, r3-0963, r3-0964, r3-0965
2026-09-07 04:01:34 +08:00

2.1 KiB
Raw Blame History

summary read_when title
Curated links to the most used OpenClaw docs.
You want quick access to key docs pages
Docs directory
This page is a curated index. If you are new, start with [Getting Started](/start/getting-started). For a complete map of the docs, see [Docs hubs](/start/hubs).

Start here

Setup and reference

Channels and UX

Companion apps

Operations and safety

Related