use-openclaw-manual - 基于文档的 OpenClaw 配置技能

描述

在配置 OpenClaw 前自动查阅本地官方文档，确保配置操作准确、规范。首次使用时自动同步最新文档到本地。

通知渠道: 默认使用 webchat，可通过环境变量 DOC_NOTIFY_CHANNEL 覆盖（如：discord、telegram 等）。

核心功能

1. 文档同步 - 从 GitHub 同步 OpenClaw 官方文档到本地
2. 文档搜索 - 快速搜索本地文档中的配置相关信息
3. 配置规范 - 强制要求配置前查阅文档
4. 引用来源 - 所有配置方案必须引用文档来源

首次安装

1. 安装技能

clawhub skill install use-openclaw-manual

2. 配置 Agent（重要）

安装后需要在 AGENTS.md 中添加使用指南，让 Agent 知道使用此技能：

## 工作流程
1. 配置问题 → 使用 `use-openclaw-manual` 技能搜索文档
   - `clawhub skill run use-openclaw-manual --search <关键词>`
   - 配置方案必须引用文档来源
2. 技能操作 → 使用 `clawhub skill` 命令
3. 系统检查 → 使用 `healthcheck` 技能
4. 变更操作 → 必须用户批准

位置: ~/.openclaw/workspace-sys/AGENTS.md（或其他 workspace 的 AGENTS.md）

3. 初始化文档

首次使用本技能时，会自动执行文档同步：

# 技能安装后首次使用时自动触发
clawhub skill run use-openclaw-manual --init

同步内容:

• 从 github.com/openclaw/openclaw/docs/ 克隆
• 保存到 ~/.openclaw/workspace/docs/openclaw_manual/
• 约 713 个文件，44 个子目录
• 耗时约 30 秒

手动初始化

如需手动触发同步：

clawhub skill run use-openclaw-manual --init

使用方法

1. 配置前搜索文档

收到配置需求后，先搜索相关文档：

# 搜索关键词
clawhub skill run use-openclaw-manual --search "binding"

# 或指定主题
clawhub skill run use-openclaw-manual --search "agent workspace"
clawhub skill run use-openclaw-manual --search "cron schedule"
clawhub skill run use-openclaw-manual --search "tools profile"

2. 查阅特定主题文档

# 列出相关文档
clawhub skill run use-openclaw-manual --list "agent"

# 查看文档内容
clawhub skill run use-openclaw-manual --read "concepts/agent-workspace.md"

3. 检查文档更新

# 检查是否有新文档
clawhub skill run use-openclaw-manual --check

# 手动同步更新
clawhub skill run use-openclaw-manual --sync

4. 配置操作规范

标准流程:

1. 搜索 - grep -r 搜索本地文档
2. 阅读 - 理解相关文档内容
3. 设计 - 基于文档设计配置方案
4. 引用 - 在方案中引用文档来源
5. 批准 - 用户确认方案
6. 执行 - 按方案执行配置

示例:

用户：帮我配置 Discord 通知

助手：
1. 先查阅文档...
   $ clawhub skill run use-openclaw-manual --search "discord notification"
   
2. 找到相关文档:
   - channels/discord.md
   - automation/notifications.md
   
3. 基于文档设计配置方案:
   [方案内容，引用文档来源]
   
4. 用户批准后执行配置

文档优先级

脚本说明

sync-docs.sh

位置: scripts/sync-docs.sh（技能目录内）

功能: 同步 OpenClaw 官方文档到本地

参数:

• --init - 首次初始化（完整同步）
• --sync - 增量同步（仅更新变更文件）
• --check - 仅检查更新，不同步

环境变量:

• OPENCLAW_MANUAL_PATH - 文档目录路径（默认：$HOME/.openclaw/workspace/docs/openclaw_manual）
• LAST_COMMIT_FILE - Baseline 文件路径（默认：$OPENCLAW_MANUAL_PATH/.last-docs-commit）
• DOC_UPDATE_LOG - 日志文件路径（默认：技能目录内 docs-update.log）
• DOC_NOTIFY_CHANNEL - 通知渠道（默认：webchat）

输出:

• 同步文件数量
• 变更文件列表
• 通知（通过指定渠道发送）

search-docs.sh

位置: scripts/search-docs.sh（技能目录内）

功能: 搜索本地文档