From 1060f9b34a043d42251885716d26c0086ea954f3 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Mon, 1 Jun 2026 03:44:34 +0800 Subject: [PATCH] Add bilingual docs summaries --- CONTRIBUTING.md | 8 ++++++++ README.md | 9 +++++++++ README.zh-CN.md | 10 ++++++++++ SECURITY.md | 8 ++++++++ docs/external_data_roadmap.md | 9 +++++++++ docs/external_data_validation.md | 8 ++++++++ docs/integration_contract.md | 8 ++++++++ docs/operator_runbook.md | 9 +++++++++ docs/validation_status.md | 8 ++++++++ 9 files changed, 77 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd570a7..fb4923b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,13 @@ # Contributing + +## 中文摘要 + +- 用途：本文档围绕 `Contributing`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Ground Rules`、`Branching and Pull Requests`、`Local Verification`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 Thanks for contributing to `CryptoSnapshotPipelines`. ## Ground Rules diff --git a/README.md b/README.md index 1590e81..58d2ae3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ > ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 + +## 中文摘要 + +- 完整中文版见 [`README.zh-CN.md`](README.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。 +- 用途：本文档围绕 `CryptoSnapshotPipelines`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Upstream Boundary`、`Current Status`、`Why This Project Exists`、`Why Not Deep Learning`、`Data Source`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 Language: English | [简体中文](README.zh-CN.md) `CryptoSnapshotPipelines` is the upstream research, feature-snapshot, and release pipeline repo for crypto strategies. diff --git a/README.zh-CN.md b/README.zh-CN.md index 7573ce8..f166b36 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 `CryptoSnapshotPipelines` for `CryptoLeaderRotation`. +- 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](README.md) | 简体中文 `CryptoSnapshotPipelines` 是加密货币策略的上游研究、特征快照和发布流水线仓库。当前生产 artifact family 仍然是 `crypto_leader_rotation` 这条 Binance Spot leader universe。 diff --git a/SECURITY.md b/SECURITY.md index 63173b5..7ce10c6 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,5 +1,13 @@ # Security Policy + +## 中文摘要 + +- 用途：本文档围绕 `Security Policy`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 Thanks for helping keep `CryptoSnapshotPipelines` safe. This repository is part of a research and release pipeline. Please do **not** open a public issue for vulnerabilities involving credentials, broker access, cloud resources, order execution, or secret material. diff --git a/docs/external_data_roadmap.md b/docs/external_data_roadmap.md index 6a6c148..43b3292 100644 --- a/docs/external_data_roadmap.md +++ b/docs/external_data_roadmap.md @@ -1,5 +1,14 @@ # External Data Roadmap + +## 中文摘要 + +- 用途：本文档围绕 `External Data Roadmap`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Why Binance-Only Is Not Enough`、`First-Priority External Enhancements`、`Current Preparation Implemented`、`Merge Rules`、`Validation Needed Before Production Enablement`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 + ## Why Binance-Only Is Not Enough The current repository intentionally starts with Binance Spot daily OHLCV because it is easy to audit, reproducible, and sufficient for a strong practical baseline. diff --git a/docs/external_data_validation.md b/docs/external_data_validation.md index ecbf0a8..15d7e03 100644 --- a/docs/external_data_validation.md +++ b/docs/external_data_validation.md @@ -1,5 +1,13 @@ # External Data Validation + +## 中文摘要 + +- 用途：本文档围绕 `External Data Validation`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Current External-Data Policy`、`Why DOGEUSDT Is Now A Cautious Holdout`、`Providers Used`、`Quality Gate`、`Current Quality Report`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 This document records the current external-data validation state after multiple real reruns and profile sweeps. Current top-line conclusion: diff --git a/docs/integration_contract.md b/docs/integration_contract.md index 7ef005c..fe70bd7 100644 --- a/docs/integration_contract.md +++ b/docs/integration_contract.md @@ -1,5 +1,13 @@ # Integration Contract + +## 中文摘要 + +- 用途：本文档围绕 `Integration Contract`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Canonical Downstream Files`、``artifact_manifest.json``、``live_pool_legacy.json``、``live_pool.json``、`Firestore Contract`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 This document defines the production contract exposed by `CryptoSnapshotPipelines` to downstream strategy systems. The current v1 artifact namespace remains `crypto-leader-rotation` for compatibility with existing published objects and downstream readers. diff --git a/docs/operator_runbook.md b/docs/operator_runbook.md index e358b4b..86ace1f 100644 --- a/docs/operator_runbook.md +++ b/docs/operator_runbook.md @@ -1,5 +1,14 @@ # Operator Runbook + +## 中文摘要 + +- 用途：本文档围绕 `Operator Runbook`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Scope`、`Research Path Vs Production Path`、`Upstream Reporting Responsibilities`、`Monthly Codex Remediation`、`Standard Monthly Flow`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 + ## Scope This runbook covers the production release path for `CryptoSnapshotPipelines`. diff --git a/docs/validation_status.md b/docs/validation_status.md index 45c26ac..ad56114 100644 --- a/docs/validation_status.md +++ b/docs/validation_status.md @@ -1,5 +1,13 @@ # Validation Status + +## 中文摘要 + +- 用途：本文档围绕 `Validation Status`，用于理解 `CryptoLeaderRotation` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Frozen Default`、`Current Strategy Validation Snapshot`、`Publish Chain Validation Completed`、`External Data Preparation Validation Completed`、`Not Finished Yet`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 This document tracks the current frozen production decision and what still remains experimental. ## Frozen Default