这里是项目文档入口。README 负责项目概览和快速开始;更完整的配置、部署、功能说明和排障内容从这里进入。
| 我想要 | 先看 | 继续看 |
| 快速了解项目能做什么 | README | 完整配置与部署指南 |
| 第一次把项目跑起来 | 小白客户端安装与配置 | 完整配置与部署指南 |
| 配置大模型渠道 | LLM 配置指南 | LLM 服务商配置指南(含 xAI Grok 直连) |
| 配置推送通知 | 通知能力基线 | 完整配置与部署指南 |
| 部署到服务器或云平台 | 部署指南 | 云端 WebUI 部署、Zeabur 部署 |
| 使用 Bot / IM 接入 | Bot 命令与接入 | Bot 平台配置、Grok Bot 集成 |
| 排查运行问题 | FAQ | 更新日志 |
| 处理数据源失败或降级 | 数据源稳定性与故障处理图示 | FAQ |
| 参与开发或提交 PR | 贡献指南 | API 规格 |
| 文档 | 内容 |
| README | 项目定位、核心能力、快速开始、推送效果 |
| 小白客户端安装与配置 | 面向不会代码用户的客户端下载、Anspire Open / AIHubMix 模型配置、新闻源配置和常见问题 |
| 完整配置与部署指南 | 环境准备、运行方式、配置说明、部署路径和常见问题 |
| FAQ | 常见配置、模型、通知、部署和运行问题 |
| 数据源稳定性与故障处理图示 | Tushare、TickFlow、AkShare、Efinance、YFinance、Longbridge 等已接入源的使用场景、fallback 链路和推荐配置 |
| 数据中心 | 只读 Provider 能力、数据集质量、精确市场支持与运行时优先级 |
| 更新日志 | 版本变化、能力调整和迁移说明 |
| 文档 | 内容 |
| LLM 配置指南 | 大模型渠道、三层配置、Web 设置页和常见模型配置 |
| LLM 服务商配置指南 | Provider 预设、Actions 映射、错误分类和诊断建议 |
| LiteLLM YAML 示例 | LiteLLM 多渠道配置示例 |
| Grok Bot Skill 示例 | 给 Grok Bot 粘贴的最小 Skill,调用现有 REST |
| 通知能力基线 | 企业微信、飞书、Telegram、Discord、Slack、邮件等通知渠道配置 |
| Tushare 股票列表指南 | Tushare 股票列表相关配置和使用说明 |
| 文档 | 内容 |
| 自选股变化状态与下一步 | 首页自选股列表的变化、状态、下一步三段信号、映射规则和后续扩展边界 |
| Bot 命令与接入 | Bot 命令、Webhook、平台接入和回调说明 |
| Bot 平台配置 | 飞书、钉钉、Discord 等 Bot 配置截图和补充说明 |
| 实时告警中心 | EventMonitor 基线、Web 规则管理、通知结果、冷却状态和 Phase 边界 |
| 个股研究聚合 API | 单一 stock-profile 契约、分块质量状态、代码归一与后续 Web 边界 |
| DecisionSignal 决策信号专题 | AI 建议池字段语义、API、Web 展示、告警/通知/组合风险联动、后验评估、脱敏、迁移与回滚 |
| ETF 轮动 | --etf-rotation 规则化双动量轮动:规则、配置、报告章节、参数平原解读与数据告警边界 |
| ResearchArtifact 结构化研究产物 | structured_report 字段、Thesis / Evidence / Invalidation / Next Action / Data Quality 契约和旧报告兼容边界 |
| 组合风险与暴露看板 | 持仓页风险旗标、市场暴露、币种暴露和价格质量聚合展示 |
| 选股解释契约 | Why Selected / Why Now 的后端确定性解释、来源、质量状态与缺失值边界 |
| 资讯 / 情报源 | RSS/Atom 合规资讯源配置、测试、拉取、去重、存储、查询与安全边界 |
| 分析上下文包契约、运行态消费与可见性 | AnalysisContextPack 首版范围、字段质量状态、/内部契约、P3 Prompt 摘要消费、P4 历史/API/Web 低敏可见性、P5 数据质量评分、P6 迁移回滚与源码锚点;完整指南补充 #1386 阶段感知分析、迁移与回滚入口 |
| 图片识别 Prompt | 图片识别股票信息的 Prompt 与使用边界 |
| OpenClaw Skill 集成 | OpenClaw / Skill 外部集成说明 |
| Grok Bot 集成 | 2026-08-11 Grok Bot(AI teammate)与 DSA REST / DecisionSignal / 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 | 繁體中文項目概覽與快速開始 |