Docs: add nav titles across docs (#5689)

This commit is contained in:
Seb Slight
2026-01-31 16:04:03 -05:00
committed by GitHub
parent 1295b67057
commit abcaa8c7a9
270 changed files with 279 additions and 0 deletions

View File

@@ -3,6 +3,7 @@ summary: "Run the ACP bridge for IDE integrations"
read_when:
- Setting up ACP-based IDE integrations
- Debugging ACP session routing to the Gateway
title: "acp"
---
# acp

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw agent` (send one agent turn via the Gateway)"
read_when:
- You want to run one agent turn from scripts (optionally deliver reply)
title: "agent"
---
# `openclaw agent`

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw agents` (list/add/delete/set identity)"
read_when:
- You want multiple isolated agents (workspaces + routing + auth)
title: "agents"
---
# `openclaw agents`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw approvals` (exec approvals for gateway or
read_when:
- You want to edit exec approvals from the CLI
- You need to manage allowlists on gateway or node hosts
title: "approvals"
---
# `openclaw approvals`

View File

@@ -4,6 +4,7 @@ read_when:
- You use `openclaw browser` and want examples for common tasks
- You want to control a browser running on another machine via a node host
- You want to use the Chrome extension relay (attach/detach via toolbar button)
title: "browser"
---
# `openclaw browser`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw channels` (accounts, status, login/logout,
read_when:
- You want to add/remove channel accounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage)
- You want to check channel status or tail channel logs
title: "channels"
---
# `openclaw channels`

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw config` (get/set/unset config values)"
read_when:
- You want to read or edit config non-interactively
title: "config"
---
# `openclaw config`

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw configure` (interactive configuration prompts)"
read_when:
- You want to tweak credentials, devices, or agent defaults interactively
title: "configure"
---
# `openclaw configure`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw cron` (schedule and run background jobs)"
read_when:
- You want scheduled jobs and wakeups
- Youre debugging cron execution and logs
title: "cron"
---
# `openclaw cron`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw dashboard` (open the Control UI)"
read_when:
- You want to open the Control UI with your current token
- You want to print the URL without launching a browser
title: "dashboard"
---
# `openclaw dashboard`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw devices` (device pairing + token rotation/
read_when:
- You are approving device pairing requests
- You need to rotate or revoke device tokens
title: "devices"
---
# `openclaw devices`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw directory` (self, peers, groups)"
read_when:
- You want to look up contacts/groups/self ids for a channel
- You are developing a channel directory adapter
title: "directory"
---
# `openclaw directory`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw dns` (wide-area discovery helpers)"
read_when:
- You want wide-area discovery (DNS-SD) via Tailscale + CoreDNS
- Youre setting up split DNS for a custom discovery domain (example: openclaw.internal)
title: "dns"
---
# `openclaw dns`

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw docs` (search the live docs index)"
read_when:
- You want to search the live OpenClaw docs from the terminal
title: "docs"
---
# `openclaw docs`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw doctor` (health checks + guided repairs)"
read_when:
- You have connectivity/auth issues and want guided fixes
- You updated and want a sanity check
title: "doctor"
---
# `openclaw doctor`

View File

@@ -4,6 +4,7 @@ read_when:
- Running the Gateway from the CLI (dev or servers)
- Debugging Gateway auth, bind modes, and connectivity
- Discovering gateways via Bonjour (LAN + tailnet)
title: "gateway"
---
# Gateway CLI

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw health` (gateway health endpoint via RPC)"
read_when:
- You want to quickly check the running Gateways health
title: "health"
---
# `openclaw health`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw hooks` (agent hooks)"
read_when:
- You want to manage agent hooks
- You want to install or update hooks
title: "hooks"
---
# `openclaw hooks`

View File

@@ -3,6 +3,7 @@ summary: "OpenClaw CLI reference for `openclaw` commands, subcommands, and optio
read_when:
- Adding or modifying CLI commands or options
- Documenting new command surfaces
title: "CLI Reference"
---
# CLI reference

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw logs` (tail gateway logs via RPC)"
read_when:
- You need to tail Gateway logs remotely (without SSH)
- You want JSON log lines for tooling
title: "logs"
---
# `openclaw logs`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw memory` (status/index/search)"
read_when:
- You want to index or search semantic memory
- Youre debugging memory availability or indexing
title: "memory"
---
# `openclaw memory`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw message` (send + channel actions)"
read_when:
- Adding or modifying message CLI actions
- Changing outbound channel behavior
title: "message"
---
# `openclaw message`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw models` (status/list/set/scan, aliases, fa
read_when:
- You want to change default models or view provider auth status
- You want to scan available models/providers and debug auth profiles
title: "models"
---
# `openclaw models`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw node` (headless node host)"
read_when:
- Running the headless node host
- Pairing a non-macOS node for system.run
title: "node"
---
# `openclaw node`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw nodes` (list/status/approve/invoke, camera
read_when:
- Youre managing paired nodes (cameras, screen, canvas)
- You need to approve requests or invoke node commands
title: "nodes"
---
# `openclaw nodes`

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw onboard` (interactive onboarding wizard)"
read_when:
- You want guided setup for gateway, workspace, auth, channels, and skills
title: "onboard"
---
# `openclaw onboard`

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw pairing` (approve/list pairing requests)"
read_when:
- Youre using pairing-mode DMs and need to approve senders
title: "pairing"
---
# `openclaw pairing`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw plugins` (list, install, enable/disable, d
read_when:
- You want to install or manage in-process Gateway plugins
- You want to debug plugin load failures
title: "plugins"
---
# `openclaw plugins`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw reset` (reset local state/config)"
read_when:
- You want to wipe local state while keeping the CLI installed
- You want a dry-run of what would be removed
title: "reset"
---
# `openclaw reset`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw security` (audit and fix common security f
read_when:
- You want to run a quick security audit on config/state
- You want to apply safe “fix” suggestions (chmod, tighten defaults)
title: "security"
---
# `openclaw security`

View File

@@ -2,6 +2,7 @@
summary: "CLI reference for `openclaw sessions` (list stored sessions + usage)"
read_when:
- You want to list stored sessions and see recent activity
title: "sessions"
---
# `openclaw sessions`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw setup` (initialize config + workspace)"
read_when:
- Youre doing first-run setup without the full onboarding wizard
- You want to set the default workspace path
title: "setup"
---
# `openclaw setup`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw skills` (list/info/check) and skill eligib
read_when:
- You want to see which skills are available and ready to run
- You want to debug missing binaries/env/config for skills
title: "skills"
---
# `openclaw skills`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw status` (diagnostics, probes, usage snapsh
read_when:
- You want a quick diagnosis of channel health + recent session recipients
- You want a pasteable “all” status for debugging
title: "status"
---
# `openclaw status`

View File

@@ -4,6 +4,7 @@ read_when:
- You want to enqueue a system event without creating a cron job
- You need to enable or disable heartbeats
- You want to inspect system presence entries
title: "system"
---
# `openclaw system`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw tui` (terminal UI connected to the Gateway
read_when:
- You want a terminal UI for the Gateway (remote-friendly)
- You want to pass url/token/session from scripts
title: "tui"
---
# `openclaw tui`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw uninstall` (remove gateway service + local
read_when:
- You want to remove the gateway service and/or local state
- You want a dry-run first
title: "uninstall"
---
# `openclaw uninstall`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw update` (safe-ish source update + gateway
read_when:
- You want to update a source checkout safely
- You need to understand `--update` shorthand behavior
title: "update"
---
# `openclaw update`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw voicecall` (voice-call plugin command surf
read_when:
- You use the voice-call plugin and want the CLI entry points
- You want quick examples for `voicecall call|continue|status|tail|expose`
title: "voicecall"
---
# `openclaw voicecall`

View File

@@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw webhooks` (webhook helpers + Gmail Pub/Sub
read_when:
- You want to wire Gmail Pub/Sub events into OpenClaw
- You want webhook helper commands
title: "webhooks"
---
# `openclaw webhooks`