Files
openclaw/docs/start/hubs.md

196 lines
5.9 KiB
Markdown
Raw Normal View History

---
2026-01-30 03:15:10 +01:00
summary: "Hubs that link to every OpenClaw doc"
read_when:
- You want a complete map of the documentation
title: "Docs Hubs"
---
2026-01-31 21:13:13 +09:00
# Docs hubs
<Note>
If you are new to OpenClaw, start with [Getting Started](/start/getting-started).
</Note>
Use these hubs to discover every page, including deep dives and reference docs that dont appear in the left nav.
## Start here
2026-01-10 14:51:21 -06:00
- [Index](/)
- [Getting Started](/start/getting-started)
- [Quick start](/start/quickstart)
2026-01-10 14:51:21 -06:00
- [Onboarding](/start/onboarding)
- [Wizard](/start/wizard)
- [Setup](/start/setup)
- [Dashboard (local Gateway)](http://127.0.0.1:18789/)
- [Help](/help)
- [Docs directory](/start/docs-directory)
2026-01-10 14:51:21 -06:00
- [Configuration](/gateway/configuration)
- [Configuration examples](/gateway/configuration-examples)
2026-01-30 03:15:10 +01:00
- [OpenClaw assistant](/start/openclaw)
2026-01-10 14:51:21 -06:00
- [Showcase](/start/showcase)
- [Lore](/start/lore)
## Installation + updates
2026-01-10 14:51:21 -06:00
- [Docker](/install/docker)
- [Nix](/install/nix)
- [Updating / rollback](/install/updating)
2026-01-13 07:58:47 +00:00
- [Bun workflow (experimental)](/install/bun)
## Core concepts
2026-01-10 14:51:21 -06:00
- [Architecture](/concepts/architecture)
- [Features](/concepts/features)
- [Network hub](/network)
2026-01-10 14:51:21 -06:00
- [Agent runtime](/concepts/agent)
- [Agent workspace](/concepts/agent-workspace)
2026-01-12 05:28:17 +00:00
- [Memory](/concepts/memory)
2026-01-10 14:51:21 -06:00
- [Agent loop](/concepts/agent-loop)
2026-01-07 17:15:53 +01:00
- [Streaming + chunking](/concepts/streaming)
2026-01-10 14:51:21 -06:00
- [Multi-agent routing](/concepts/multi-agent)
- [Compaction](/concepts/compaction)
- [Sessions](/concepts/session)
- [Sessions (alias)](/concepts/sessions)
- [Session pruning](/concepts/session-pruning)
- [Session tools](/concepts/session-tool)
- [Queue](/concepts/queue)
- [Slash commands](/tools/slash-commands)
- [RPC adapters](/reference/rpc)
- [TypeBox schemas](/concepts/typebox)
- [Timezone handling](/concepts/timezone)
- [Presence](/concepts/presence)
- [Discovery + transports](/gateway/discovery)
- [Bonjour](/gateway/bonjour)
- [Channel routing](/channels/channel-routing)
- [Groups](/channels/groups)
- [Group messages](/channels/group-messages)
2026-01-10 14:51:21 -06:00
- [Model failover](/concepts/model-failover)
- [OAuth](/concepts/oauth)
## Providers + ingress
- [Chat channels hub](/channels)
- [Model providers hub](/providers/models)
- [WhatsApp](/channels/whatsapp)
- [Telegram](/channels/telegram)
- [Telegram (grammY notes)](/channels/grammy)
- [Slack](/channels/slack)
- [Discord](/channels/discord)
- [Mattermost](/channels/mattermost) (plugin)
- [Signal](/channels/signal)
iMessage: promote BlueBubbles and refresh docs/skills (#8415) * feat: Make BlueBubbles the primary iMessage integration - Remove old imsg skill (skills/imsg/SKILL.md) - Create new BlueBubbles skill (skills/bluebubbles/SKILL.md) with message tool examples - Add keep-alive script documentation for VM/headless setups to docs/channels/bluebubbles.md - AppleScript that pokes Messages.app every 5 minutes - LaunchAgent configuration for automatic execution - Prevents Messages.app from going idle in VM environments - Update all documentation to prioritize BlueBubbles over legacy imsg: - Mark imsg channel as legacy throughout docs - Update README.md channel lists - Update wizard, hubs, pairing, and index docs - Update FAQ to recommend BlueBubbles for iMessage - Update RPC docs to note imsg as legacy pattern - Update Chinese documentation (zh-CN) - Replace imsg examples with generic macOS skill examples where appropriate BlueBubbles is now the recommended first-class iMessage integration, with the legacy imsg integration marked for potential future removal. * refactor: Update import paths and improve code formatting - Adjusted import paths in session-status-tool.ts, whatsapp-heartbeat.ts, and heartbeat-runner.ts for consistency. - Reformatted code for better readability by aligning and grouping related imports and function parameters. - Enhanced error messages and conditional checks for clarity in heartbeat-runner.ts. * skills: restore imsg skill and align bluebubbles skill * docs: update FAQ for clarity and formatting - Adjusted the formatting of the FAQ section to ensure consistent bullet point alignment. - No content changes were made, only formatting improvements for better readability. * style: oxfmt touched files * fix: preserve BlueBubbles developer reference (#8415) (thanks @tyler6204)
2026-02-03 18:06:54 -08:00
- [BlueBubbles (iMessage)](/channels/bluebubbles)
- [iMessage (legacy)](/channels/imessage)
- [Location parsing](/channels/location)
2026-01-10 14:51:21 -06:00
- [WebChat](/web/webchat)
- [Webhooks](/automation/webhook)
- [Gmail Pub/Sub](/automation/gmail-pubsub)
## Gateway + operations
2026-01-10 14:51:21 -06:00
- [Gateway runbook](/gateway)
- [Network model](/gateway/network-model)
2026-01-10 14:51:21 -06:00
- [Gateway pairing](/gateway/pairing)
- [Gateway lock](/gateway/gateway-lock)
- [Background process](/gateway/background-process)
- [Health](/gateway/health)
- [Heartbeat](/gateway/heartbeat)
- [Doctor](/gateway/doctor)
- [Logging](/gateway/logging)
- [Sandboxing](/gateway/sandboxing)
- [Dashboard](/web/dashboard)
- [Control UI](/web/control-ui)
- [Remote access](/gateway/remote)
- [Remote gateway README](/gateway/remote-gateway-readme)
- [Tailscale](/gateway/tailscale)
- [Security](/gateway/security)
- [Troubleshooting](/gateway/troubleshooting)
## Tools + automation
2026-01-10 14:51:21 -06:00
- [Tools surface](/tools)
2026-01-23 00:49:32 +00:00
- [OpenProse](/prose)
2026-01-10 14:51:21 -06:00
- [CLI reference](/cli)
- [Exec tool](/tools/exec)
2026-01-10 14:51:21 -06:00
- [Elevated mode](/tools/elevated)
- [Cron jobs](/automation/cron-jobs)
- [Cron vs Heartbeat](/automation/cron-vs-heartbeat)
2026-01-10 14:51:21 -06:00
- [Thinking + verbose](/tools/thinking)
- [Models](/concepts/models)
- [Sub-agents](/tools/subagents)
- [Agent send CLI](/tools/agent-send)
- [Terminal UI](/web/tui)
2026-01-10 14:51:21 -06:00
- [Browser control](/tools/browser)
- [Browser (Linux troubleshooting)](/tools/browser-linux-troubleshooting)
- [Polls](/automation/poll)
## Nodes, media, voice
2026-01-10 14:51:21 -06:00
- [Nodes overview](/nodes)
- [Camera](/nodes/camera)
- [Images](/nodes/images)
- [Audio](/nodes/audio)
- [Location command](/nodes/location-command)
- [Voice wake](/nodes/voicewake)
- [Talk mode](/nodes/talk)
## Platforms
2026-01-10 14:51:21 -06:00
- [Platforms overview](/platforms)
- [macOS](/platforms/macos)
- [iOS](/platforms/ios)
- [Android](/platforms/android)
- [Windows (WSL2)](/platforms/windows)
- [Linux](/platforms/linux)
- [Web surfaces](/web)
2026-01-07 21:37:05 +01:00
2026-01-08 23:06:56 +01:00
## macOS companion app (advanced)
2026-01-07 21:37:05 +01:00
2026-01-10 14:51:21 -06:00
- [macOS dev setup](/platforms/mac/dev-setup)
- [macOS menu bar](/platforms/mac/menu-bar)
- [macOS voice wake](/platforms/mac/voicewake)
- [macOS voice overlay](/platforms/mac/voice-overlay)
- [macOS WebChat](/platforms/mac/webchat)
- [macOS Canvas](/platforms/mac/canvas)
- [macOS child process](/platforms/mac/child-process)
- [macOS health](/platforms/mac/health)
- [macOS icon](/platforms/mac/icon)
- [macOS logging](/platforms/mac/logging)
- [macOS permissions](/platforms/mac/permissions)
- [macOS remote](/platforms/mac/remote)
- [macOS signing](/platforms/mac/signing)
- [macOS release](/platforms/mac/release)
2026-01-11 10:15:37 +00:00
- [macOS gateway (launchd)](/platforms/mac/bundled-gateway)
2026-01-10 14:51:21 -06:00
- [macOS XPC](/platforms/mac/xpc)
- [macOS skills](/platforms/mac/skills)
- [macOS Peekaboo](/platforms/mac/peekaboo)
## Workspace + templates
2026-01-10 14:51:21 -06:00
- [Skills](/tools/skills)
2026-01-30 21:01:02 +01:00
- [ClawHub](/tools/clawhub)
2026-01-10 14:51:21 -06:00
- [Skills config](/tools/skills-config)
- [Default AGENTS](/reference/AGENTS.default)
- [Templates: AGENTS](/reference/templates/AGENTS)
- [Templates: BOOTSTRAP](/reference/templates/BOOTSTRAP)
- [Templates: HEARTBEAT](/reference/templates/HEARTBEAT)
- [Templates: IDENTITY](/reference/templates/IDENTITY)
- [Templates: SOUL](/reference/templates/SOUL)
- [Templates: TOOLS](/reference/templates/TOOLS)
- [Templates: USER](/reference/templates/USER)
2026-01-08 23:06:56 +01:00
## Experiments (exploratory)
2026-01-10 14:51:21 -06:00
- [Onboarding config protocol](/experiments/onboarding-config-protocol)
- [Research: memory](/experiments/research/memory)
- [Model config exploration](/experiments/proposals/model-config)
## Project
- [Credits](/reference/credits)
## Testing + release
2026-01-10 14:51:21 -06:00
- [Testing](/reference/test)
- [Release checklist](/reference/RELEASING)
- [Device models](/reference/device-models)