文档中心

这里是项目文档入口。README 负责项目概览和快速开始；更完整的配置、部署、功能说明和排障内容从这里进入。

按场景选择

我想要	先看	继续看
快速了解项目能做什么	README	完整配置与部署指南
第一次把项目跑起来	README	完整配置与部署指南
配置大模型渠道	LLM 配置指南	LLM 服务商配置指南
配置推送通知	通知能力基线	完整配置与部署指南
部署到服务器或云平台	部署指南	云端 WebUI 部署、Zeabur 部署
使用 Bot / IM 接入	Bot 命令与接入	Bot 平台配置
排查运行问题	FAQ	更新日志
参与开发或提交 PR	贡献指南	API 规格

快速开始

文档	内容
README	项目定位、核心能力、快速开始、推送效果
完整配置与部署指南	环境准备、运行方式、配置说明、部署路径和常见问题
FAQ	常见配置、模型、通知、部署和运行问题
更新日志	版本变化、能力调整和迁移说明

配置

文档	内容
LLM 配置指南	大模型渠道、三层配置、Web 设置页和常见模型配置
LLM 服务商配置指南	Provider 预设、Actions 映射、错误分类和诊断建议
LiteLLM YAML 示例	LiteLLM 多渠道配置示例
通知能力基线	企业微信、飞书、Telegram、Discord、Slack、邮件等通知渠道配置
Tushare 股票列表指南	Tushare 股票列表相关配置和使用说明

使用专题

文档	内容
Bot 命令与接入	Bot 命令、Webhook、平台接入和回调说明
Bot 平台配置	飞书、钉钉、Discord 等 Bot 配置截图和补充说明
图片识别 Prompt	图片识别股票信息的 Prompt 与使用边界
OpenClaw Skill 集成	OpenClaw / Skill 外部集成说明

部署与打包

文档	内容
部署指南	服务器部署、Docker、systemd、Supervisor 等部署方式
云端 WebUI 部署	云服务器访问 WebUI 的部署说明
Zeabur 部署	Zeabur 平台部署说明
桌面端打包说明	Electron 桌面端和 Web 构建产物打包说明

参考与开发

文档	内容
API 规格	FastAPI OpenAPI 规格产物
贡献指南	Issue、PR、测试、文档同步和协作要求

多语言

文档	内容
英文文档索引	English documentation index
英文 README	English project overview and quick start
繁中 README	繁體中文項目概覽與快速開始