Skip to content

Commit 6401344

Browse files
PigbibiPigbibi
committed
Add bilingual docs summaries
1 parent c8df477 commit 6401344

8 files changed

Lines changed: 76 additions & 0 deletions

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。
44
5+
6+
## 中文摘要
7+
8+
- 完整中文版见 [`README.zh-CN.md`](README.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。
9+
- 用途：本文档围绕 `QuantAdvisorResearch`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。
10+
- 主要覆盖：`Repository Role`、`Horizon Source Split`、`Boundary`、`AI Usage`、`Local Example`。
11+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
12+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
13+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
514
[English](README.md) | [简体中文](README.zh-CN.md)
615

716
Intelligent advisory research system for QuantStrategyLab.

‎README.zh-CN.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。
44
5+
6+
## English summary
7+
8+
- Full English version: [`README.md`](README.md). This summary keeps an English entry point in the Chinese file.
9+
- Purpose: this document covers `QuantAdvisorResearch` for `QuantAdvisorResearch`.
10+
- Main topics: `仓库定位`, `短中长线来源分工`, `当前 MVP`, `版本管理`, `来源模式`.
11+
- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches.
12+
- 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.
13+
- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body.
14+
515
[English](README.md) | [简体中文](README.zh-CN.md)
616

717
QuantStrategyLab 的“智慧投顾研究系统”协调仓库。它把事件证据、主题动量、市场确认和 AI shadow 背景整理成普通投资者能读懂的研究结论；不下单、不管理仓位、不接券商凭证，也不做账户级个性化建议。

‎docs/advisory_contract.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Intelligent Advisory Artifact Contract
22

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `Intelligent Advisory Artifact Contract`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Report`、`Policy`、`Recommendation`、`Theme-first Candidate`、`Final Decisions`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
11+
312
## Report
413

514
Required top-level fields:

‎docs/data_factor_roadmap.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Data Source and Factor Roadmap
22

3+
4+
## 中文摘要
5+
6+
- 完整中文版见 [`data_factor_roadmap.zh-CN.md`](data_factor_roadmap.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。
7+
- 用途：本文档围绕 `Data Source and Factor Roadmap`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。
8+
- 主要覆盖：`Current Direction`、`Current Inputs`、`PoliticalEventTrackingResearch`、`ResearchSignalContextPipelines`、`QuantAdvisorResearch`。
9+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
10+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
11+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
312
[English](data_factor_roadmap.md) | [简体中文](data_factor_roadmap.zh-CN.md)
413

514
## Current Direction

‎docs/data_factor_roadmap.zh-CN.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 数据源与因子完善路线
22

3+
4+
## English summary
5+
6+
- Full English version: [`data_factor_roadmap.md`](data_factor_roadmap.md). This summary keeps an English entry point in the Chinese file.
7+
- Purpose: this document covers `数据源与因子完善路线` for `QuantAdvisorResearch`.
8+
- Main topics: `当前结论`, `现有数据源盘点`, `PoliticalEventTrackingResearch`, `ResearchSignalContextPipelines`, `QuantAdvisorResearch`.
9+
- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches.
10+
- 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.
11+
- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body.
12+
313
[English](data_factor_roadmap.md) | [简体中文](data_factor_roadmap.zh-CN.md)
414

515
## 当前结论

‎docs/notification_format.zh-CN.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 智慧投顾研究通知格式
22

3+
4+
## English summary
5+
6+
- Full English version: [`notification_format.md`](notification_format.md). This summary keeps an English entry point in the Chinese file.
7+
- Purpose: this document covers `智慧投顾研究通知格式` for `QuantAdvisorResearch`.
8+
- Main topics: `设计原则`, `通用字段`, `RSS 摘要`, `Telegram 摘要`, `邮件摘要`.
9+
- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches.
10+
- 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.
11+
- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body.
12+
313
## 设计原则
414

515
通知可以明确展示“推荐什么标的、为什么、适合短中长哪类周期”。边界不是禁止推荐，而是禁止把智慧投顾研究结论变成账户级操作：

‎docs/system_design.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Intelligent Advisory Research System Design
22

3+
4+
## 中文摘要
5+
6+
- 完整中文版见 [`system_design.zh-CN.md`](system_design.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。
7+
- 用途：本文档围绕 `Intelligent Advisory Research System Design`，用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。
8+
- 主要覆盖：`Architecture`、`Data Flow`、`Horizon Ownership`、`Design Patterns`、`Publishing Cadence`。
9+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
10+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
11+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
312
[English](system_design.md) | [简体中文](system_design.zh-CN.md)
413

514
## Architecture

‎docs/system_design.zh-CN.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 智慧投顾研究系统设计
22

3+
4+
## English summary
5+
6+
- Full English version: [`system_design.md`](system_design.md). This summary keeps an English entry point in the Chinese file.
7+
- Purpose: this document covers `智慧投顾研究系统设计` for `QuantAdvisorResearch`.
8+
- Main topics: `当前架构理解`, `智慧投顾研究数据流`, `设计模式`, `不推荐方案`, `MVP 验证标准`.
9+
- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches.
10+
- 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.
11+
- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body.
12+
313
[English](system_design.md) | [简体中文](system_design.zh-CN.md)
414

515
## 当前架构理解

0 commit comments

Comments
 (0)