docs: add /help hub and Node/npm PATH guide
This commit is contained in:
32
docs/help/faq.md
Normal file
32
docs/help/faq.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
summary: "FAQ (concepts): what Clawdbot is and how it fits together"
|
||||
read_when:
|
||||
- You’re new and want the mental model
|
||||
- You’re not debugging a specific error
|
||||
---
|
||||
|
||||
# FAQ (concepts)
|
||||
|
||||
If you’re here because something’s broken, start with: [Troubleshooting](/help/troubleshooting).
|
||||
|
||||
## What is Clawdbot?
|
||||
|
||||
Clawdbot is a personal AI assistant you run on your own devices. It replies on the messaging surfaces you already use (WhatsApp, Telegram, Slack, Discord, Signal, iMessage, WebChat) and can also do voice + a live Canvas on supported platforms. The **Gateway** is the always‑on control plane; the assistant is the product.
|
||||
|
||||
## What runtime do I need?
|
||||
|
||||
Node **>= 22** is required. `pnpm` is recommended. Bun is **not recommended** for the Gateway.
|
||||
|
||||
## What’s the recommended setup flow?
|
||||
|
||||
Use the onboarding wizard:
|
||||
|
||||
```bash
|
||||
clawdbot onboard --install-daemon
|
||||
```
|
||||
|
||||
Then use:
|
||||
|
||||
```bash
|
||||
clawdbot dashboard
|
||||
```
|
||||
20
docs/help/index.md
Normal file
20
docs/help/index.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
summary: "Help hub: common fixes, install sanity, and where to look when something breaks"
|
||||
read_when:
|
||||
- You’re new and want the “what do I click/run” guide
|
||||
- Something broke and you want the fastest path to a fix
|
||||
---
|
||||
|
||||
# Help
|
||||
|
||||
If you want a quick “get unstuck” flow, start here:
|
||||
|
||||
- **Troubleshooting:** [Start here](/help/troubleshooting)
|
||||
- **Install sanity (Node/npm/PATH):** [Node.js + npm (PATH sanity)](/install/node)
|
||||
- **Gateway issues:** [Gateway troubleshooting](/gateway/troubleshooting)
|
||||
- **Logs:** [Logging](/logging) and [Gateway logging](/gateway/logging)
|
||||
- **Repairs:** [Doctor](/gateway/doctor)
|
||||
|
||||
If you’re looking for conceptual questions (not “something broke”):
|
||||
|
||||
- [FAQ (concepts)](/help/faq)
|
||||
59
docs/help/troubleshooting.md
Normal file
59
docs/help/troubleshooting.md
Normal file
@@ -0,0 +1,59 @@
|
||||
---
|
||||
summary: "Troubleshooting hub: symptoms → checks → fixes"
|
||||
read_when:
|
||||
- You see an error and want the fix path
|
||||
- The installer says “success” but the CLI doesn’t work
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
## First 60 seconds
|
||||
|
||||
Run these in order:
|
||||
|
||||
```bash
|
||||
clawdbot status
|
||||
clawdbot status --all
|
||||
clawdbot daemon status
|
||||
clawdbot logs --follow
|
||||
clawdbot doctor
|
||||
```
|
||||
|
||||
If the gateway is reachable, deep probes:
|
||||
|
||||
```bash
|
||||
clawdbot status --deep
|
||||
```
|
||||
|
||||
## Common “it broke” cases
|
||||
|
||||
### `clawdbot: command not found`
|
||||
|
||||
Almost always a Node/npm PATH issue. Start here:
|
||||
|
||||
- [Node.js + npm (PATH sanity)](/install/node)
|
||||
|
||||
### Gateway “unauthorized”, can’t connect, or keeps reconnecting
|
||||
|
||||
- [Gateway troubleshooting](/gateway/troubleshooting)
|
||||
- [Gateway authentication](/gateway/authentication)
|
||||
|
||||
### Daemon says running, but RPC probe fails
|
||||
|
||||
- [Gateway troubleshooting](/gateway/troubleshooting)
|
||||
- [Background process / daemon](/gateway/background-process)
|
||||
|
||||
### Model/auth failures (rate limit, billing, “all models failed”)
|
||||
|
||||
- [Models](/cli/models)
|
||||
- [OAuth / auth concepts](/concepts/oauth)
|
||||
|
||||
### When filing an issue
|
||||
|
||||
Paste a safe report:
|
||||
|
||||
```bash
|
||||
clawdbot status --all
|
||||
```
|
||||
|
||||
If you can, include the relevant log tail from `clawdbot logs --follow`.
|
||||
Reference in New Issue
Block a user