diff --git a/README.md b/README.md index 02849e6..19d8888 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ > ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 + +## 中文摘要 + +- 完整中文版见 [`README.zh-CN.md`](README.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。 +- 用途：本文档围绕 `QuantAdvisorResearch`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Repository Role`、`Horizon Source Split`、`Boundary`、`AI Usage`、`Local Example`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 [English](README.md) | [简体中文](README.zh-CN.md) Intelligent advisory research system for QuantStrategyLab. diff --git a/README.zh-CN.md b/README.zh-CN.md index 919c5cd..16d982b 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -2,6 +2,16 @@ > ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 + +## English summary + +- Full English version: [`README.md`](README.md). This summary keeps an English entry point in the Chinese file. +- Purpose: this document covers `QuantAdvisorResearch` for `QuantAdvisorResearch`. +- Main topics: `仓库定位`, `短中长线来源分工`, `当前 MVP`, `版本管理`, `来源模式`. +- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches. +- For live trading, secrets, Cloud Run, exchange, or broker API changes, validate in test or dry-run mode first and do not change production only from examples. +- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body. + [English](README.md) | [简体中文](README.zh-CN.md) QuantStrategyLab 的“智慧投顾研究系统”协调仓库。它把事件证据、主题动量、市场确认和 AI shadow 背景整理成普通投资者能读懂的研究结论；不下单、不管理仓位、不接券商凭证，也不做账户级个性化建议。 diff --git a/docs/advisory_contract.md b/docs/advisory_contract.md index 6756d3e..ebf93e6 100644 --- a/docs/advisory_contract.md +++ b/docs/advisory_contract.md @@ -1,5 +1,14 @@ # Intelligent Advisory Artifact Contract + +## 中文摘要 + +- 用途：本文档围绕 `Intelligent Advisory Artifact Contract`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Report`、`Policy`、`Recommendation`、`Theme-first Candidate`、`Final Decisions`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 + ## Report Required top-level fields: diff --git a/docs/data_factor_roadmap.md b/docs/data_factor_roadmap.md index 76a2404..0eada1a 100644 --- a/docs/data_factor_roadmap.md +++ b/docs/data_factor_roadmap.md @@ -1,5 +1,14 @@ # Data Source and Factor Roadmap + +## 中文摘要 + +- 完整中文版见 [`data_factor_roadmap.zh-CN.md`](data_factor_roadmap.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。 +- 用途：本文档围绕 `Data Source and Factor Roadmap`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Current Direction`、`Current Inputs`、`PoliticalEventTrackingResearch`、`ResearchSignalContextPipelines`、`QuantAdvisorResearch`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 [English](data_factor_roadmap.md) | [简体中文](data_factor_roadmap.zh-CN.md) ## Current Direction diff --git a/docs/data_factor_roadmap.zh-CN.md b/docs/data_factor_roadmap.zh-CN.md index 96231b1..9fdd1a1 100644 --- a/docs/data_factor_roadmap.zh-CN.md +++ b/docs/data_factor_roadmap.zh-CN.md @@ -1,5 +1,15 @@ # 数据源与因子完善路线 + +## English summary + +- Full English version: [`data_factor_roadmap.md`](data_factor_roadmap.md). This summary keeps an English entry point in the Chinese file. +- Purpose: this document covers `数据源与因子完善路线` for `QuantAdvisorResearch`. +- Main topics: `当前结论`, `现有数据源盘点`, `PoliticalEventTrackingResearch`, `ResearchSignalContextPipelines`, `QuantAdvisorResearch`. +- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches. +- For live trading, secrets, Cloud Run, exchange, or broker API changes, validate in test or dry-run mode first and do not change production only from examples. +- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body. + [English](data_factor_roadmap.md) | [简体中文](data_factor_roadmap.zh-CN.md) ## 当前结论 diff --git a/docs/notification_format.zh-CN.md b/docs/notification_format.zh-CN.md index 661a8f0..6b66793 100644 --- a/docs/notification_format.zh-CN.md +++ b/docs/notification_format.zh-CN.md @@ -1,5 +1,15 @@ # 智慧投顾研究通知格式 + +## English summary + +- Full English version: [`notification_format.md`](notification_format.md). This summary keeps an English entry point in the Chinese file. +- Purpose: this document covers `智慧投顾研究通知格式` for `QuantAdvisorResearch`. +- Main topics: `设计原则`, `通用字段`, `RSS 摘要`, `Telegram 摘要`, `邮件摘要`. +- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches. +- For live trading, secrets, Cloud Run, exchange, or broker API changes, validate in test or dry-run mode first and do not change production only from examples. +- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body. + ## 设计原则 通知可以明确展示“推荐什么标的、为什么、适合短中长哪类周期”。边界不是禁止推荐，而是禁止把智慧投顾研究结论变成账户级操作： diff --git a/docs/system_design.md b/docs/system_design.md index f9235d4..4d12709 100644 --- a/docs/system_design.md +++ b/docs/system_design.md @@ -1,5 +1,14 @@ # Intelligent Advisory Research System Design + +## 中文摘要 + +- 完整中文版见 [`system_design.zh-CN.md`](system_design.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。 +- 用途：本文档围绕 `Intelligent Advisory Research System Design`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Architecture`、`Data Flow`、`Horizon Ownership`、`Design Patterns`、`Publishing Cadence`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 [English](system_design.md) | [简体中文](system_design.zh-CN.md) ## Architecture diff --git a/docs/system_design.zh-CN.md b/docs/system_design.zh-CN.md index 37e12b5..bdbbdd9 100644 --- a/docs/system_design.zh-CN.md +++ b/docs/system_design.zh-CN.md @@ -1,5 +1,15 @@ # 智慧投顾研究系统设计 + +## English summary + +- Full English version: [`system_design.md`](system_design.md). This summary keeps an English entry point in the Chinese file. +- Purpose: this document covers `智慧投顾研究系统设计` for `QuantAdvisorResearch`. +- Main topics: `当前架构理解`, `智慧投顾研究数据流`, `设计模式`, `不推荐方案`, `MVP 验证标准`. +- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches. +- For live trading, secrets, Cloud Run, exchange, or broker API changes, validate in test or dry-run mode first and do not change production only from examples. +- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body. + [English](system_design.md) | [简体中文](system_design.zh-CN.md) ## 当前架构理解