From 7953c9fcfedae677be6aa48c978b6853cd2c1765 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Mon, 1 Jun 2026 03:48:50 +0800 Subject: [PATCH] Add bilingual docs summaries --- README.md | 9 +++++++++ README.zh-CN.md | 10 ++++++++++ docs/market-regime-control-plan.md | 9 +++++++++ docs/market-regime-control-plan.zh-CN.md | 10 ++++++++++ 4 files changed, 38 insertions(+) diff --git a/README.md b/README.md index e23170a..e0bb330 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ > ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 + +## 中文摘要 + +- 完整中文版见 [`README.zh-CN.md`](README.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。 +- 用途：本文档围绕 `QuantStrategyPlugins`，用于理解 `QuantStrategyPlugins` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`What Is Public`、`What Stays Out`、`Plugins`、`Usage`、`Notification and Log i18n`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 Open sidecar strategy plugins for QuantStrategyLab runtimes. Documentation: English | [简体中文](README.zh-CN.md) diff --git a/README.zh-CN.md b/README.zh-CN.md index ca33cea..4f26eba 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 `QuantStrategyPlugins` for `QuantStrategyPlugins`. +- Main topics: `开源范围`, `不进入开源仓库的内容`, `插件`, `使用方式`, `通知和日志 i18n`. +- 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. + QuantStrategyLab 的开源侧车策略插件仓库。 文档：[English](README.md) | 简体中文 diff --git a/docs/market-regime-control-plan.md b/docs/market-regime-control-plan.md index c3e3ccc..658091e 100644 --- a/docs/market-regime-control-plan.md +++ b/docs/market-regime-control-plan.md @@ -1,5 +1,14 @@ # Market Regime Control Design Plan + +## 中文摘要 + +- 完整中文版见 [`market-regime-control-plan.zh-CN.md`](market-regime-control-plan.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。 +- 用途：本文档围绕 `Market Regime Control Design Plan`，用于理解 `QuantStrategyPlugins` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Goals`、`Component Responsibilities`、`Arbitration Order`、`Strategy Consumption`、`Indicator Tiers`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 [简体中文](./market-regime-control-plan.zh-CN.md) This document records the current design boundary, arbitration order, strategy diff --git a/docs/market-regime-control-plan.zh-CN.md b/docs/market-regime-control-plan.zh-CN.md index 8880e32..103429d 100644 --- a/docs/market-regime-control-plan.zh-CN.md +++ b/docs/market-regime-control-plan.zh-CN.md @@ -1,5 +1,15 @@ # Market Regime Control 统一插件方案 + +## English summary + +- Full English version: [`market-regime-control-plan.md`](market-regime-control-plan.md). This summary keeps an English entry point in the Chinese file. +- Purpose: this document covers `Market Regime Control 统一插件方案` for `QuantStrategyPlugins`. +- Main topics: `目标`, `组件职责`, `仲裁优先级`, `策略消费方式`, `版本管理`. +- 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](./market-regime-control-plan.md) 本文档记录 `market_regime_control` 的当前设计边界、信号优先级、策略消费方式和回测结论。