Skip to content

Commit b24da2e

Browse files
authored
Polish bilingual documentation (#31)
1 parent 6580ab4 commit b24da2e

7 files changed

Lines changed: 7 additions & 52 deletions

README.zh-CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ CryptoStrategies 是 QuantStrategyLab 的加密货币策略包。为 Binance 执
1313
- **策略包**:保存可复用策略代码、元数据和运行入口。
1414
- **Snapshot 流水线**:生成官方 live-pool snapshot、ranking、回测和发布证据。
1515
- **执行平台**:把策略接到券商、dry-run 检查、通知和 live 部署控制。
16-
- **共享基础设施**沉淀契约、配置、适配器、插件和审计 workflow,供多仓复用。
16+
- **共享基础设施**维护契约、配置、适配器、插件和审计 workflow,供多仓复用。
1717

1818
本仓库负责策略代码和元数据。对 snapshot-backed 加密策略来说,本仓库只消费上游 live pool,不在本地重建月度池成员或顺序。本仓库不保存券商凭据,不直接提交订单,也不替代 live enable 前需要看的 live-pool/release 证据。
1919

docs/crypto_cross_platform_strategy_spec.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
# Crypto cross-platform strategy spec
22

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

4-
## 中文摘要
5-
6-
- 完整中文版见 [`crypto_cross_platform_strategy_spec.zh-CN.md`](crypto_cross_platform_strategy_spec.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
7-
- 用途:本文档围绕 `Crypto cross-platform strategy spec`,用于理解 `CryptoStrategies` 的配置、运行、部署、研究或验收边界。
8-
- 主要覆盖:`Canonical required inputs``Target mode``Runtime adapters``Allowed and forbidden boundaries``Current rollout`
9-
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
10-
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
11-
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
125
This repository now follows the same contract split used by the US equity stack:
136

147
- `CryptoStrategies` owns pure strategy logic, manifests, metadata, and runtime adapters

docs/crypto_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: [`crypto_cross_platform_strategy_spec.md`](crypto_cross_platform_strategy_spec.md). This summary keeps an English entry point in the Chinese file.
7-
- Purpose: this document covers `加密策略跨平台规范` for `CryptoStrategies`.
8-
- Main topics: `canonical 输入集合`, `target mode`, `runtime adapter`, `允许和禁止`, `当前落地状态`.
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](crypto_cross_platform_strategy_spec.md)
124

135
这个仓库现在按照美股那套边界来拆:
146

docs/crypto_portability_checklist.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
# Crypto portability checklist
22

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

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

147
- [ ] `required_inputs` only use canonical crypto input names

docs/crypto_portability_checklist.zh-CN.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# 加密策略 portability 清单
22

3-
4-
## English summary
5-
6-
- Full English version: [`crypto_portability_checklist.md`](crypto_portability_checklist.md). This summary keeps an English entry point in the Chinese file.
7-
- Purpose: this document covers `加密策略 portability 清单` for `CryptoStrategies`.
8-
- Main topics: `加密策略 portability 清单`.
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](crypto_portability_checklist.md)
124

135
在某条加密策略真正放到下游平台启用前,先过这张清单。
146

docs/crypto_strategy_template.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
# Crypto strategy template
22

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

4-
## 中文摘要
5-
6-
- 完整中文版见 [`crypto_strategy_template.zh-CN.md`](crypto_strategy_template.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
7-
- 用途:本文档围绕 `Crypto strategy template`,用于理解 `CryptoStrategies` 的配置、运行、部署、研究或验收边界。
8-
- 主要覆盖:`Minimum layout``Minimum checklist``StrategyDefinition``Manifest and entrypoint``Runtime adapter`
9-
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
10-
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
11-
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
125
Use this template when adding a new crypto strategy profile.
136

147
## Minimum layout

docs/crypto_strategy_template.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: [`crypto_strategy_template.md`](crypto_strategy_template.md). This summary keeps an English entry point in the Chinese file.
7-
- Purpose: this document covers `加密策略模板` for `CryptoStrategies`.
8-
- Main topics: `最小目录结构`, `最小接入清单`, `StrategyDefinition 必填项`, `Manifest 和 entrypoint`, `Runtime adapter`.
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](crypto_strategy_template.md)
124

135
以后新增加密策略时,按这个模板落。
146

0 commit comments

Comments
 (0)