Skip to content

Commit 7953c9f

Browse files
committed
Add bilingual docs summaries
1 parent e4d64a0 commit 7953c9f

4 files changed

Lines changed: 38 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+
- 用途:本文档围绕 `QuantStrategyPlugins`,用于理解 `QuantStrategyPlugins` 的配置、运行、部署、研究或验收边界。
10+
- 主要覆盖:`What Is Public``What Stays Out``Plugins``Usage``Notification and Log i18n`
11+
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
12+
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
13+
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
514
Open sidecar strategy plugins for QuantStrategyLab runtimes.
615

716
Documentation: English | [简体中文](README.zh-CN.md)

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 `QuantStrategyPlugins` for `QuantStrategyPlugins`.
10+
- Main topics: `开源范围`, `不进入开源仓库的内容`, `插件`, `使用方式`, `通知和日志 i18n`.
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
QuantStrategyLab 的开源侧车策略插件仓库。
616

717
文档:[English](README.md) | 简体中文

docs/market-regime-control-plan.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Market Regime Control Design Plan
22

3+
4+
## 中文摘要
5+
6+
- 完整中文版见 [`market-regime-control-plan.zh-CN.md`](market-regime-control-plan.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
7+
- 用途:本文档围绕 `Market Regime Control Design Plan`,用于理解 `QuantStrategyPlugins` 的配置、运行、部署、研究或验收边界。
8+
- 主要覆盖:`Goals``Component Responsibilities``Arbitration Order``Strategy Consumption``Indicator Tiers`
9+
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
10+
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
11+
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
312
[简体中文](./market-regime-control-plan.zh-CN.md)
413

514
This document records the current design boundary, arbitration order, strategy

docs/market-regime-control-plan.zh-CN.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Market Regime Control 统一插件方案
22

3+
4+
## English summary
5+
6+
- Full English version: [`market-regime-control-plan.md`](market-regime-control-plan.md). This summary keeps an English entry point in the Chinese file.
7+
- Purpose: this document covers `Market Regime Control 统一插件方案` for `QuantStrategyPlugins`.
8+
- Main topics: `目标`, `组件职责`, `仲裁优先级`, `策略消费方式`, `版本管理`.
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](./market-regime-control-plan.md)
414

515
本文档记录 `market_regime_control` 的当前设计边界、信号优先级、策略消费方式和回测结论。

0 commit comments

Comments
 (0)