Skip to content

Commit fe3b3bc

Browse files
committed
Add bilingual docs summaries
1 parent 9106ed3 commit fe3b3bc

3 files changed

Lines changed: 28 additions & 0 deletions

File tree

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+
- 用途:本文档围绕 `ResearchSignalContextPipelines`,用于理解 `ResearchSignalContextPipelines` 的配置、运行、部署、研究或验收边界。
10+
- 主要覆盖:`Repository Role``Boundary``Current Status``Operating Model``Name and Horizon Boundary`
11+
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
12+
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
13+
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
514
[English](README.md) | [简体中文](README.zh-CN.md)
615

716
Research-only signal context artifact repository 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 `ResearchSignalContextPipelines` for `ResearchSignalContextPipelines`.
10+
- Main topics: `仓库定位`, `边界`, `当前状态`, `运行模式`, `名称和周期边界`.
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 的研究型信号上下文 artifact 仓库。

docs/architecture.md

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

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

514
QuantStrategyLab already separates strategy math, snapshot generation, runtime

0 commit comments

Comments
 (0)