Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions docs/platform_notification_outcomes.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
# Platform Notification Outcomes

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

## 中文摘要

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

[English](platform_notification_outcomes.md)

## English summary

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

Expand Down
9 changes: 1 addition & 8 deletions docs/platform_repo_boundaries.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
# Platform Repository Boundaries

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

## 中文摘要

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

Expand Down
10 changes: 1 addition & 9 deletions docs/platform_repo_boundaries.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# 平台仓库职责边界


## English summary

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

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

Expand Down
8 changes: 0 additions & 8 deletions docs/quantconnect.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# QuantConnect Connector


## 中文摘要

- 用途:本文档围绕 `QuantConnect Connector`,用于理解 `QuantPlatformKit` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Example`、`References`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
`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.

The connector supports:
Expand Down
9 changes: 0 additions & 9 deletions docs/strategy_plugin_runtime_contract.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Strategy Plugin Runtime Contract


## 中文摘要

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

This document describes how platform runtimes consume sidecar strategy plugin
Expand Down
10 changes: 0 additions & 10 deletions docs/strategy_plugin_runtime_contract.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
# 策略插件运行时契约


## English summary

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

本文档说明平台运行时如何消费侧车策略插件 artifact,例如上游 snapshot
Expand Down
10 changes: 1 addition & 9 deletions docs/us_equity_cross_platform_strategy_spec.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# US equity cross-platform strategy spec


## 中文摘要

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

## Goal

Expand Down
10 changes: 1 addition & 9 deletions docs/us_equity_cross_platform_strategy_spec.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# 美股策略跨平台设计规范


## English summary

- 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.
- Purpose: this document covers `美股策略跨平台设计规范` for `QuantPlatformKit`.
- 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](us_equity_cross_platform_strategy_spec.md)

## 目标

Expand Down
10 changes: 1 addition & 9 deletions docs/us_equity_execution_translation_spec.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# US equity execution translation spec


## 中文摘要

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

## Goal

Expand Down
10 changes: 1 addition & 9 deletions docs/us_equity_execution_translation_spec.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# 美股执行翻译规范


## English summary

- Full English version: [`us_equity_execution_translation_spec.md`](us_equity_execution_translation_spec.md). This summary keeps an English entry point in the Chinese file.
- Purpose: this document covers `美股执行翻译规范` for `QuantPlatformKit`.
- Main topics: `目标`, `各平台当前原生执行模式`, `翻译层边界`, `翻译层允许依赖的输入`, ``weight -> value` 规则`.
- 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](us_equity_execution_translation_spec.md)

## 目标

Expand Down