Skip to content

Commit 4a4c545

Browse files
committed
Polish bilingual documentation
1 parent 3b6a0a9 commit 4a4c545

11 files changed

Lines changed: 8 additions & 96 deletions

docs/platform_notification_outcomes.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
# Platform Notification Outcomes
22

3+
[简体中文](platform_notification_outcomes.zh-CN.md)
34

4-
## 中文摘要
5-
6-
- 完整中文版见 [`platform_notification_outcomes.zh-CN.md`](platform_notification_outcomes.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
7-
- 用途:本文档围绕 `Platform Notification Outcomes`,用于理解 `QuantPlatformKit` 的配置、运行、部署、研究或验收边界。
8-
- 主要覆盖:`Execution Stages``Skip Reasons``Notification Envelope``Platform Responsibilities`
9-
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
10-
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
11-
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
125
Platform runtimes should use the shared execution outcome and notification
136
envelope helpers in `quant_platform_kit` instead of defining private stage or
147
notification sink semantics in each repository.

docs/platform_notification_outcomes.zh-CN.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
# 平台通知与执行结果语义
22

3+
[English](platform_notification_outcomes.md)
34

4-
## English summary
5-
6-
- Full English version: [`platform_notification_outcomes.md`](platform_notification_outcomes.md). This summary keeps an English entry point in the Chinese file.
7-
- Purpose: this document covers `平台通知与执行结果语义` for `QuantPlatformKit`.
8-
- Main topics: `执行 Stage`, `跳过原因`, `通知 Envelope`, `平台仓库职责`.
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.
125
平台运行时应复用 `quant_platform_kit` 里的共享执行结果和通知 envelope
136
helper,不要在每个仓库里各自定义一套 stage 或通知投递语义。
147

docs/platform_repo_boundaries.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
# Platform Repository Boundaries
22

3+
[简体中文](platform_repo_boundaries.zh-CN.md)
34

4-
## 中文摘要
5-
6-
- 完整中文版见 [`platform_repo_boundaries.zh-CN.md`](platform_repo_boundaries.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
7-
- 用途:本文档围绕 `Platform Repository Boundaries`,用于理解 `QuantPlatformKit` 的配置、运行、部署、研究或验收边界。
8-
- 主要覆盖:`QuantPlatformKit``Strategy Repositories``Platform Repositories``Practical Rule`
9-
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
10-
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
11-
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
125
This document describes how `QuantPlatformKit` fits with strategy repositories
136
and broker platform repositories.
147

docs/platform_repo_boundaries.zh-CN.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# 平台仓库职责边界
22

3-
4-
## English summary
5-
6-
- Full English version: [`platform_repo_boundaries.md`](platform_repo_boundaries.md). This summary keeps an English entry point in the Chinese file.
7-
- Purpose: this document covers `平台仓库职责边界` for `QuantPlatformKit`.
8-
- Main topics: `QuantPlatformKit`, `策略仓库`, `平台仓库`, `实用判断`.
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.
3+
[English](platform_repo_boundaries.md)
124

135
这份文档说明 `QuantPlatformKit` 如何与策略仓库、券商平台仓库协作。
146

docs/quantconnect.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# QuantConnect Connector
22

3-
4-
## 中文摘要
5-
6-
- 用途:本文档围绕 `QuantConnect Connector`,用于理解 `QuantPlatformKit` 的配置、运行、部署、研究或验收边界。
7-
- 主要覆盖:`Example``References`
8-
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
9-
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
10-
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
113
`quant_platform_kit.quantconnect` contains small, dependency-free helpers for platform repositories that deploy a strategy to QuantConnect Cloud while keeping account wiring and secrets outside this public repository.
124

135
The connector supports:

docs/strategy_plugin_runtime_contract.md

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

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

145
This document describes how platform runtimes consume sidecar strategy plugin

docs/strategy_plugin_runtime_contract.zh-CN.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
# 策略插件运行时契约
22

3-
4-
## English summary
5-
6-
- Full English version: [`strategy_plugin_runtime_contract.md`](strategy_plugin_runtime_contract.md). This summary keeps an English entry point in the Chinese file.
7-
- Purpose: this document covers `策略插件运行时契约` for `QuantPlatformKit`.
8-
- Main topics: `职责边界`, `平台挂载配置`, `插件定义`, `Runtime Loader`, `行为边界`.
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-
133
[English](./strategy_plugin_runtime_contract.md)
144

155
本文档说明平台运行时如何消费侧车策略插件 artifact,例如上游 snapshot

docs/us_equity_cross_platform_strategy_spec.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# US equity cross-platform strategy spec
22

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

135
## Goal
146

docs/us_equity_cross_platform_strategy_spec.zh-CN.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# 美股策略跨平台设计规范
22

3-
4-
## English summary
5-
6-
- Full English version: [`us_equity_cross_platform_strategy_spec.md`](us_equity_cross_platform_strategy_spec.md). This summary keeps an English entry point in the Chinese file.
7-
- Purpose: this document covers `美股策略跨平台设计规范` for `QuantPlatformKit`.
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.
3+
[English](us_equity_cross_platform_strategy_spec.md)
124

135
## 目标
146

docs/us_equity_execution_translation_spec.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# US equity execution translation spec
22

3-
4-
## 中文摘要
5-
6-
- 完整中文版见 [`us_equity_execution_translation_spec.zh-CN.md`](us_equity_execution_translation_spec.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
7-
- 用途:本文档围绕 `US equity execution translation spec`,用于理解 `QuantPlatformKit` 的配置、运行、部署、研究或验收边界。
8-
- 主要覆盖:`Goal``Native execution modes by platform``Translation boundary``Required inputs to translation`、``weight -> value` rules`
9-
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
10-
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
11-
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
3+
[简体中文](us_equity_execution_translation_spec.zh-CN.md)
124

135
## Goal
146

0 commit comments

Comments
 (0)