From 055b497332b702c38004caab3ce2bae81df372b3 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 5 Jan 2026 21:46:52 +0100 Subject: [PATCH] docs: add hubs index and clawdibuted --- README.md | 39 ++++++------ docs/docs.json | 1 + docs/hubs.md | 158 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 1 + 4 files changed, 179 insertions(+), 20 deletions(-) create mode 100644 docs/hubs.md diff --git a/README.md b/README.md index bb50b902b..8fdb5dcb9 100644 --- a/README.md +++ b/README.md @@ -84,14 +84,14 @@ If you run from source, prefer `pnpm clawdbot …` (not global `clawdbot`). - **[Voice Wake](https://docs.clawdbot.com/voicewake) + [Talk Mode](https://docs.clawdbot.com/talk)** — always-on speech for macOS/iOS/Android with ElevenLabs. - **[Live Canvas](https://docs.clawdbot.com/mac/canvas)** — agent-driven visual workspace with [A2UI](https://docs.clawdbot.com/refactor/canvas-a2ui). - **[First-class tools](https://docs.clawdbot.com/tools)** — browser, canvas, nodes, cron, sessions, and Discord/Slack actions. -- **[Companion apps](https://docs.clawdbot.com/clawdbot-mac)** — macOS menu bar app + iOS/Android [nodes](https://docs.clawdbot.com/nodes). +- **[Companion apps](https://docs.clawdbot.com/macos)** — macOS menu bar app + iOS/Android [nodes](https://docs.clawdbot.com/nodes). - **[Onboarding](https://docs.clawdbot.com/wizard) + [skills](https://docs.clawdbot.com/skills)** — wizard-driven setup with bundled/managed/workspace skills. ## Everything we built so far ### Core platform - [Gateway WS control plane](https://docs.clawdbot.com/gateway) with sessions, presence, config, cron, webhooks, [Control UI](https://docs.clawdbot.com/web), and [Canvas host](https://docs.clawdbot.com/refactor/canvas-a2ui). -- [CLI surface](https://docs.clawdbot.com/agent-send): gateway, agent, send, [wizard](https://docs.clawdbot.com/wizard), [doctor](https://docs.clawdbot.com/doctor), and [TUI](https://docs.clawdbot.com/tui). +- [CLI surface](https://docs.clawdbot.com/agent-send): gateway, agent, send, [wizard](https://docs.clawdbot.com/wizard), and [doctor](https://docs.clawdbot.com/doctor). - [Pi agent runtime](https://docs.clawdbot.com/agent) in RPC mode with tool streaming and block streaming. - [Session model](https://docs.clawdbot.com/session): `main` for direct chats, group isolation, activation modes, queue modes, reply-back. Group rules: [Groups](https://docs.clawdbot.com/groups). - [Media pipeline](https://docs.clawdbot.com/images): images/audio/video, transcription hooks, size caps, temp file lifecycle. Audio details: [Audio](https://docs.clawdbot.com/audio). @@ -101,9 +101,9 @@ If you run from source, prefer `pnpm clawdbot …` (not global `clawdbot`). - [Group routing](https://docs.clawdbot.com/group-messages): mention gating, reply tags, per-surface chunking and routing. Surface rules: [Surface routing](https://docs.clawdbot.com/surface). ### Apps + nodes -- [macOS app](https://docs.clawdbot.com/clawdbot-mac): menu bar control plane, [Voice Wake](https://docs.clawdbot.com/voicewake)/PTT, [Talk Mode](https://docs.clawdbot.com/talk) overlay, [WebChat](https://docs.clawdbot.com/webchat), debug tools, [remote gateway](https://docs.clawdbot.com/remote) control. -- [iOS node](https://docs.clawdbot.com/ios/connect): [Canvas](https://docs.clawdbot.com/mac/canvas), [Voice Wake](https://docs.clawdbot.com/voicewake), [Talk Mode](https://docs.clawdbot.com/talk), camera, screen recording, Bonjour pairing. -- [Android node](https://docs.clawdbot.com/android/connect): [Canvas](https://docs.clawdbot.com/mac/canvas), [Talk Mode](https://docs.clawdbot.com/talk), camera, screen recording, optional SMS. +- [macOS app](https://docs.clawdbot.com/macos): menu bar control plane, [Voice Wake](https://docs.clawdbot.com/voicewake)/PTT, [Talk Mode](https://docs.clawdbot.com/talk) overlay, [WebChat](https://docs.clawdbot.com/webchat), debug tools, [remote gateway](https://docs.clawdbot.com/remote) control. +- [iOS node](https://docs.clawdbot.com/ios): [Canvas](https://docs.clawdbot.com/mac/canvas), [Voice Wake](https://docs.clawdbot.com/voicewake), [Talk Mode](https://docs.clawdbot.com/talk), camera, screen recording, Bonjour pairing. +- [Android node](https://docs.clawdbot.com/android): [Canvas](https://docs.clawdbot.com/mac/canvas), [Talk Mode](https://docs.clawdbot.com/talk), camera, screen recording, optional SMS. - [macOS node mode](https://docs.clawdbot.com/nodes): system.run/notify + canvas/camera exposure. ### Tools + automation @@ -117,13 +117,12 @@ If you run from source, prefer `pnpm clawdbot …` (not global `clawdbot`). - [Control UI](https://docs.clawdbot.com/web) + [WebChat](https://docs.clawdbot.com/webchat) served directly from the Gateway. - [Tailscale Serve/Funnel](https://docs.clawdbot.com/tailscale) or [SSH tunnels](https://docs.clawdbot.com/remote) with token/password auth. - [Nix mode](https://docs.clawdbot.com/nix) for declarative config; [Docker](https://docs.clawdbot.com/docker)-based installs. -- [Doctor](https://docs.clawdbot.com/doctor) migrations, [logging](https://docs.clawdbot.com/logging), release tooling: [Releasing](https://docs.clawdbot.com/releasing). +- [Doctor](https://docs.clawdbot.com/doctor) migrations, [logging](https://docs.clawdbot.com/logging). ## How it works (short) ``` -WhatsApp / Telegram / Slack / Discord / Signal -iMessage / WebChat +WhatsApp / Telegram / Slack / Discord / Signal / iMessage / WebChat │ ▼ ┌───────────────────────────────┐ @@ -151,7 +150,7 @@ iMessage / WebChat ClawdHub is a minimal skill registry. With ClawdHub enabled, the agent can search for skills automatically and pull in new ones as needed. -https://clawdhub.com +https://ClawdHub.com ## Chat commands @@ -189,13 +188,13 @@ Build/run: `./scripts/restart-mac.sh` (packages + launches). - Voice trigger forwarding + Canvas surface. - Controlled via `clawdbot nodes …`. -Runbook: [iOS connect](https://docs.clawdbot.com/ios/connect). +Runbook: [iOS connect](https://docs.clawdbot.com/ios). ### Android node (optional) - Pairs via the same Bridge + pairing flow as iOS. - Exposes Canvas, Camera, and Screen capture commands. -- Runbook: [Android connect](https://docs.clawdbot.com/android/connect). +- Runbook: [Android connect](https://docs.clawdbot.com/android). ## Agent workspace + skills @@ -225,12 +224,12 @@ Minimal `~/.clawdbot/clawdbot.json` (model + defaults): Details: [Security guide](https://docs.clawdbot.com/security) · [Docker + sandboxing](https://docs.clawdbot.com/docker) · [Sandbox config](https://docs.clawdbot.com/configuration) -### [WhatsApp](docs/whatsapp.md) +### [WhatsApp](https://docs.clawdbot.com/whatsapp) - Link the device: `pnpm clawdbot login` (stores creds in `~/.clawdbot/credentials`). - Allowlist who can talk to the assistant via `whatsapp.allowFrom`. -### [Telegram](docs/telegram.md) +### [Telegram](https://docs.clawdbot.com/telegram) - Set `TELEGRAM_BOT_TOKEN` or `telegram.botToken` (env wins). - Optional: set `telegram.groups` (with `telegram.groups."*".requireMention`), `telegram.allowFrom`, or `telegram.webhookUrl` as needed. @@ -243,11 +242,11 @@ Details: [Security guide](https://docs.clawdbot.com/security) · [Docker + sandb } ``` -### [Slack](docs/slack.md) +### [Slack](https://docs.clawdbot.com/slack) - Set `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN` (or `slack.botToken` + `slack.appToken`). -### [Discord](docs/discord.md) +### [Discord](https://docs.clawdbot.com/discord) - Set `DISCORD_BOT_TOKEN` or `discord.token` (env wins). - Optional: set `discord.slashCommand`, `discord.dm.allowFrom`, `discord.guilds`, or `discord.mediaMaxMb` as needed. @@ -260,15 +259,15 @@ Details: [Security guide](https://docs.clawdbot.com/security) · [Docker + sandb } ``` -### [Signal](docs/signal.md) +### [Signal](https://docs.clawdbot.com/signal) - Requires `signal-cli` and a `signal` config section. -### [iMessage](docs/imessage.md) +### [iMessage](https://docs.clawdbot.com/imessage) - macOS only; Messages must be signed in. -### [WebChat](docs/webchat.md) +### [WebChat](https://docs.clawdbot.com/webchat) - Uses the Gateway WebSocket; no separate WebChat port/config. @@ -295,7 +294,7 @@ Browser control (optional): - [Follow the onboarding wizard flow for a guided setup.](https://docs.clawdbot.com/wizard) - [Wire external triggers via the webhook surface.](https://docs.clawdbot.com/webhook) - [Set up Gmail Pub/Sub triggers.](https://docs.clawdbot.com/gmail-pubsub) -- [Learn the macOS menu bar companion details.](https://docs.clawdbot.com/macos) +- [Learn the macOS menu bar companion details.](https://docs.clawdbot.com/mac/menu-bar) - [Platform guides: Windows](https://docs.clawdbot.com/windows), [Linux](https://docs.clawdbot.com/linux), [macOS](https://docs.clawdbot.com/macos), [iOS](https://docs.clawdbot.com/ios), [Android](https://docs.clawdbot.com/android) - [Debug common failures with the troubleshooting guide.](https://docs.clawdbot.com/troubleshooting) - [Review security guidance before exposing anything.](https://docs.clawdbot.com/security) @@ -325,7 +324,7 @@ by Peter Steinberger and the community. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines, maintainers, and how to submit PRs. AI/vibe-coded PRs welcome! 🤖 -Thanks to everyone who has contributed: +Thanks to everyone who has clawdibuted:

steipete thewilloftheshadow mcinteerj joshp123 joaohlisboa petter-b mukhtharcm dan-dr Nachx639 jeffersonwarrior diff --git a/docs/docs.json b/docs/docs.json index 9d10e946c..ea2a4b20b 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -26,6 +26,7 @@ "group": "Getting Started", "pages": [ "index", + "hubs", "onboarding", "clawd", "faq" diff --git a/docs/hubs.md b/docs/hubs.md new file mode 100644 index 000000000..73e92442f --- /dev/null +++ b/docs/hubs.md @@ -0,0 +1,158 @@ +--- +summary: "Hubs that link to every Clawdbot doc" +read_when: + - You want a complete map of the documentation +--- +# Docs hubs + +Use these hubs to discover every page, including deep dives and reference docs that don’t appear in the left nav. + +## Start here + +- [Index](./index.md) +- [Onboarding](./onboarding.md) +- [Wizard](./wizard.md) +- [Setup](./setup.md) +- [FAQ](./faq.md) +- [Configuration](./configuration.md) +- [Clawd (personal assistant)](./clawd.md) +- [Lore](./lore.md) + +## Installation + distribution + +- [Docker](./docker.md) +- [Nix](./nix.md) + +## Core concepts + +- [Architecture](./architecture.md) +- [Agent runtime](./agent.md) +- [Agent loop](./agent-loop.md) +- [Sessions](./session.md) +- [Sessions (alias)](./sessions.md) +- [Session tools](./session-tool.md) +- [Queue](./queue.md) +- [RPC adapters](./rpc.md) +- [TypeBox schemas](./typebox.md) +- [Presence](./presence.md) +- [Discovery + transports](./discovery.md) +- [Bonjour](./bonjour.md) +- [Surface routing](./surface.md) +- [Groups](./groups.md) +- [Group messages](./group-messages.md) + +## Providers + ingress + +- [WhatsApp](./whatsapp.md) +- [Telegram](./telegram.md) +- [Telegram (grammY notes)](./grammy.md) +- [Slack](./slack.md) +- [Discord](./discord.md) +- [Signal](./signal.md) +- [iMessage](./imessage.md) +- [WebChat](./webchat.md) +- [Webhooks](./webhook.md) +- [Gmail Pub/Sub](./gmail-pubsub.md) + +## Gateway + operations + +- [Gateway runbook](./gateway.md) +- [Gateway pairing](./gateway/pairing.md) +- [Gateway lock](./gateway-lock.md) +- [Background process](./background-process.md) +- [Health](./health.md) +- [Heartbeat](./heartbeat.md) +- [Doctor](./doctor.md) +- [Logging](./logging.md) +- [Dashboard](./dashboard.md) +- [Control UI](./control-ui.md) +- [Control API (legacy)](./control-api.md) +- [Remote access](./remote.md) +- [Remote gateway README](./remote-gateway-readme.md) +- [Tailscale](./tailscale.md) +- [Security](./security.md) +- [Troubleshooting](./troubleshooting.md) + +## Tools + automation + +- [Tools surface](./tools.md) +- [Bash tool](./bash.md) +- [Elevated mode](./elevated.md) +- [Cron + wakeups](./cron.md) +- [Thinking + verbose](./thinking.md) +- [Models](./models.md) +- [Agent send CLI](./agent-send.md) +- [Terminal UI](./tui.md) +- [Browser control](./browser.md) +- [Browser (Linux troubleshooting)](./browser-linux-troubleshooting.md) + +## Nodes, media, voice + +- [Nodes overview](./nodes.md) +- [Camera](./camera.md) +- [Images](./images.md) +- [Audio](./audio.md) +- [Location command](./location-command.md) +- [Voice wake](./voicewake.md) +- [Talk mode](./talk.md) + +## Platforms + +- [macOS app overview](./macos.md) +- [macOS dev setup](./mac/dev-setup.md) +- [macOS menu bar](./mac/menu-bar.md) +- [macOS voice wake](./mac/voicewake.md) +- [macOS voice overlay](./mac/voice-overlay.md) +- [macOS WebChat](./mac/webchat.md) +- [macOS Canvas](./mac/canvas.md) +- [macOS child process](./mac/child-process.md) +- [macOS health](./mac/health.md) +- [macOS icon](./mac/icon.md) +- [macOS logging](./mac/logging.md) +- [macOS permissions](./mac/permissions.md) +- [macOS remote](./mac/remote.md) +- [macOS signing](./mac/signing.md) +- [macOS release](./mac/release.md) +- [macOS bun gateway](./mac/bun.md) +- [macOS XPC](./mac/xpc.md) +- [macOS skills](./mac/skills.md) +- [macOS Peekaboo plan](./mac/peekaboo.md) +- [iOS node](./ios.md) +- [Android node](./android.md) +- [Windows app](./windows.md) +- [Linux app](./linux.md) +- [Web surfaces](./web.md) + +## Workspace + templates + +- [Skills](./skills.md) +- [Skills config](./skills-config.md) +- [Default AGENTS](./AGENTS.default.md) +- [Templates: AGENTS](./templates/AGENTS.md) +- [Templates: BOOTSTRAP](./templates/BOOTSTRAP.md) +- [Templates: IDENTITY](./templates/IDENTITY.md) +- [Templates: SOUL](./templates/SOUL.md) +- [Templates: TOOLS](./templates/TOOLS.md) +- [Templates: USER](./templates/USER.md) + +## Experiments + proposals + +- [Onboarding config protocol](./onboarding-config-protocol.md) +- [Research: memory](./research/memory.md) +- [Proposal: model config](./proposals/model-config.md) +- [Refactor: agent loop](./refactor/agent-loop.md) +- [Refactor: browser control simplification](./refactor/browser-control-simplification.md) +- [Refactor: Canvas A2UI](./refactor/canvas-a2ui.md) +- [Refactor: CLI unification](./refactor/cli-unification.md) +- [Refactor: gateway client](./refactor/gateway-client.md) +- [Refactor: gateway](./refactor/gateway.md) +- [Refactor: new arch](./refactor/new-arch.md) +- [Refactor: TUI](./refactor/tui.md) +- [Refactor: web gateway troubleshooting](./refactor/web-gateway-troubleshooting.md) +- [Refactor: webagent session](./refactor/webagent-session.md) + +## Testing + release + +- [Testing](./test.md) +- [Release checklist](./RELEASING.md) +- [Device models](./device-models.md) diff --git a/docs/index.md b/docs/index.md index 704447c69..76893a0b7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -128,6 +128,7 @@ Example: ## Docs - Start here: + - [Docs hubs (all pages linked)](./hubs.md) - [FAQ](./faq.md) ← *common questions answered* - [Configuration](./configuration.md) - [Nix mode](./nix.md)