mirror of
https://github.com/moltbot/moltbot.git
synced 2026-04-28 08:52:45 +00:00
Docs: add nav titles across docs (#5689)
This commit is contained in:
Seb Slight
@@ -3,6 +3,7 @@ summary: "Model authentication: OAuth, API keys, and setup-token"
|
||||
read_when:
|
||||
- Debugging model auth or OAuth expiry
|
||||
- Documenting authentication or credential storage
|
||||
title: "Authentication"
|
||||
---
|
||||
|
||||
# Authentication
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Background exec execution and process management"
|
||||
read_when:
|
||||
- Adding or modifying background exec behavior
|
||||
- Debugging long-running exec tasks
|
||||
title: "Background Exec and Process Tool"
|
||||
---
|
||||
|
||||
# Background Exec + Process Tool
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Bonjour/mDNS discovery + debugging (Gateway beacons, clients, and comm
|
||||
read_when:
|
||||
- Debugging Bonjour discovery issues on macOS/iOS
|
||||
- Changing mDNS service types, TXT records, or discovery UX
|
||||
title: "Bonjour Discovery"
|
||||
---
|
||||
|
||||
# Bonjour / mDNS discovery
|
||||
|
||||
@@ -4,6 +4,7 @@ read_when:
|
||||
- Building or debugging node clients (iOS/Android/macOS node mode)
|
||||
- Investigating pairing or bridge auth failures
|
||||
- Auditing the node surface exposed by the gateway
|
||||
title: "Bridge Protocol"
|
||||
---
|
||||
|
||||
# Bridge protocol (legacy node transport)
|
||||
|
||||
@@ -4,6 +4,7 @@ read_when:
|
||||
- You want a reliable fallback when API providers fail
|
||||
- You are running Claude Code CLI or other local AI CLIs and want to reuse them
|
||||
- You need a text-only, tool-free path that still supports sessions and images
|
||||
title: "CLI Backends"
|
||||
---
|
||||
|
||||
# CLI backends (fallback runtime)
|
||||
|
||||
@@ -4,6 +4,7 @@ read_when:
|
||||
- Learning how to configure OpenClaw
|
||||
- Looking for configuration examples
|
||||
- Setting up OpenClaw for the first time
|
||||
title: "Configuration Examples"
|
||||
---
|
||||
|
||||
# Configuration Examples
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
summary: "All configuration options for ~/.openclaw/openclaw.json with examples"
|
||||
read_when:
|
||||
- Adding or modifying config fields
|
||||
title: "Configuration"
|
||||
---
|
||||
|
||||
# Configuration 🔧
|
||||
|
||||
@@ -4,6 +4,7 @@ read_when:
|
||||
- Implementing or changing Bonjour discovery/advertising
|
||||
- Adjusting remote connection modes (direct vs SSH)
|
||||
- Designing node discovery + pairing for remote nodes
|
||||
title: "Discovery and Transports"
|
||||
---
|
||||
|
||||
# Discovery & transports
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Doctor command: health checks, config migrations, and repair steps"
|
||||
read_when:
|
||||
- Adding or modifying doctor migrations
|
||||
- Introducing breaking config changes
|
||||
title: "Doctor"
|
||||
---
|
||||
|
||||
# Doctor
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Gateway singleton guard using the WebSocket listener bind"
|
||||
read_when:
|
||||
- Running or debugging the gateway process
|
||||
- Investigating single-instance enforcement
|
||||
title: "Gateway Lock"
|
||||
---
|
||||
|
||||
# Gateway lock
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
summary: "Health check steps for channel connectivity"
|
||||
read_when:
|
||||
- Diagnosing WhatsApp channel health
|
||||
title: "Health Checks"
|
||||
---
|
||||
|
||||
# Health Checks (CLI)
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Heartbeat polling messages and notification rules"
|
||||
read_when:
|
||||
- Adjusting heartbeat cadence or messaging
|
||||
- Deciding between heartbeat and cron for scheduled tasks
|
||||
title: "Heartbeat"
|
||||
---
|
||||
|
||||
# Heartbeat (Gateway)
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
summary: "Runbook for the Gateway service, lifecycle, and operations"
|
||||
read_when:
|
||||
- Running or debugging the gateway process
|
||||
title: "Gateway Runbook"
|
||||
---
|
||||
|
||||
# Gateway service runbook
|
||||
|
||||
@@ -4,6 +4,7 @@ read_when:
|
||||
- You want to serve models from your own GPU box
|
||||
- You are wiring LM Studio or an OpenAI-compatible proxy
|
||||
- You need the safest local model guidance
|
||||
title: "Local Models"
|
||||
---
|
||||
|
||||
# Local models
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Logging surfaces, file logs, WS log styles, and console formatting"
|
||||
read_when:
|
||||
- Changing logging output or formats
|
||||
- Debugging CLI or gateway output
|
||||
title: "Logging"
|
||||
---
|
||||
|
||||
# Logging
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Run multiple OpenClaw Gateways on one host (isolation, ports, and prof
|
||||
read_when:
|
||||
- Running more than one Gateway on the same machine
|
||||
- You need isolated config/state/ports per Gateway
|
||||
title: "Multiple Gateways"
|
||||
---
|
||||
|
||||
# Multiple Gateways (same host)
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
summary: "Expose an OpenAI-compatible /v1/chat/completions HTTP endpoint from the Gateway"
|
||||
read_when:
|
||||
- Integrating tools that expect OpenAI Chat Completions
|
||||
title: "OpenAI Chat Completions"
|
||||
---
|
||||
|
||||
# OpenAI Chat Completions (HTTP)
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Expose an OpenResponses-compatible /v1/responses HTTP endpoint from th
|
||||
read_when:
|
||||
- Integrating clients that speak the OpenResponses API
|
||||
- You want item-based inputs, client tool calls, or SSE events
|
||||
title: "OpenResponses API"
|
||||
---
|
||||
|
||||
# OpenResponses API (HTTP)
|
||||
|
||||
@@ -4,6 +4,7 @@ read_when:
|
||||
- Implementing node pairing approvals without macOS UI
|
||||
- Adding CLI flows for approving remote nodes
|
||||
- Extending gateway protocol with node management
|
||||
title: "Gateway-Owned Pairing"
|
||||
---
|
||||
|
||||
# Gateway-owned pairing (Option B)
|
||||
|
||||
@@ -4,6 +4,7 @@ read_when:
|
||||
- Implementing or updating gateway WS clients
|
||||
- Debugging protocol mismatches or connect failures
|
||||
- Regenerating protocol schema/models
|
||||
title: "Gateway Protocol"
|
||||
---
|
||||
|
||||
# Gateway protocol (WebSocket)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
summary: "SSH tunnel setup for OpenClaw.app connecting to a remote gateway"
|
||||
read_when: "Connecting the macOS app to a remote gateway over SSH"
|
||||
title: "Remote Gateway Setup"
|
||||
---
|
||||
|
||||
# Running OpenClaw.app with a Remote Gateway
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
summary: "Remote access using SSH tunnels (Gateway WS) and tailnets"
|
||||
read_when:
|
||||
- Running or troubleshooting remote gateway setups
|
||||
title: "Remote Access"
|
||||
---
|
||||
|
||||
# Remote access (SSH, tunnels, and tailnets)
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
summary: "Security considerations and threat model for running an AI gateway with shell access"
|
||||
read_when:
|
||||
- Adding features that widen access or automation
|
||||
title: "Security"
|
||||
---
|
||||
|
||||
# Security 🔒
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Integrated Tailscale Serve/Funnel for the Gateway dashboard"
|
||||
read_when:
|
||||
- Exposing the Gateway Control UI outside localhost
|
||||
- Automating tailnet or public dashboard access
|
||||
title: "Tailscale"
|
||||
---
|
||||
|
||||
# Tailscale (Gateway dashboard)
|
||||
|
||||
@@ -3,6 +3,7 @@ summary: "Invoke a single tool directly via the Gateway HTTP endpoint"
|
||||
read_when:
|
||||
- Calling tools without running a full agent turn
|
||||
- Building automations that need tool policy enforcement
|
||||
title: "Tools Invoke API"
|
||||
---
|
||||
|
||||
# Tools Invoke (HTTP)
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
summary: "Quick troubleshooting guide for common OpenClaw failures"
|
||||
read_when:
|
||||
- Investigating runtime issues or failures
|
||||
title: "Troubleshooting"
|
||||
---
|
||||
|
||||
# Troubleshooting 🔧
|
||||
|
||||
Reference in New Issue
Block a user