Skip to content

Commit 9cc6696

Browse files
PigbibiPigbibi
committed
Add bilingual docs summaries
1 parent aedfa6c commit 9cc6696

9 files changed

Lines changed: 77 additions & 0 deletions

‎CONTRIBUTING.md‎

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

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `Contributing`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Ground Rules`、`Branching and Pull Requests`、`Local Verification`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
311
Thanks for contributing to `CryptoSnapshotPipelines`.
412

513
## Ground Rules

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。
44
5+
6+
## 中文摘要
7+
8+
- 完整中文版见 [`README.zh-CN.md`](README.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。
9+
- 用途：本文档围绕 `CryptoSnapshotPipelines`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
10+
- 主要覆盖：`Upstream Boundary`、`Current Status`、`Why This Project Exists`、`Why Not Deep Learning`、`Data Source`。
11+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
12+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
13+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
514
Language: English | [简体中文](README.zh-CN.md)
615

716
`CryptoSnapshotPipelines` is the upstream research, feature-snapshot, and release pipeline repo for crypto strategies.

‎README.zh-CN.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
> ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。
44
5+
6+
## English summary
7+
8+
- Full English version: [`README.md`](README.md). This summary keeps an English entry point in the Chinese file.
9+
- Purpose: this document covers `CryptoSnapshotPipelines` for `CryptoSnapshotPipelines`.
10+
- Main topics: `当前状态`, `这个项目为什么存在`, `为什么不优先做深度学习`, `数据源`, `仓库结构`.
11+
- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches.
12+
- 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.
13+
- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body.
14+
515
语言: [English](README.md) | 简体中文
616

717
`CryptoSnapshotPipelines` 是加密货币策略的上游研究、特征快照和发布流水线仓库。当前生产 artifact family 仍然是 `crypto_leader_rotation` 这条 Binance Spot leader universe。

‎SECURITY.md‎

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

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `Security Policy`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
311
Thanks for helping keep `CryptoSnapshotPipelines` safe.
412

513
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.

‎docs/external_data_roadmap.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# External Data Roadmap
22

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `External Data Roadmap`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Why Binance-Only Is Not Enough`、`First-Priority External Enhancements`、`Current Preparation Implemented`、`Merge Rules`、`Validation Needed Before Production Enablement`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
11+
312
## Why Binance-Only Is Not Enough
413

514
The current repository intentionally starts with Binance Spot daily OHLCV because it is easy to audit, reproducible, and sufficient for a strong practical baseline.

‎docs/external_data_validation.md‎

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

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `External Data Validation`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Current External-Data Policy`、`Why DOGEUSDT Is Now A Cautious Holdout`、`Providers Used`、`Quality Gate`、`Current Quality Report`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
311
This document records the current external-data validation state after multiple real reruns and profile sweeps.
412

513
Current top-line conclusion:

‎docs/integration_contract.md‎

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

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `Integration Contract`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Canonical Downstream Files`、``artifact_manifest.json``、``live_pool_legacy.json``、``live_pool.json``、`Firestore Contract`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
311
This document defines the production contract exposed by `CryptoSnapshotPipelines` to downstream strategy systems.
412
The current v1 artifact namespace remains `crypto-leader-rotation` for compatibility with existing published objects and downstream readers.
513

‎docs/operator_runbook.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Operator Runbook
22

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `Operator Runbook`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Scope`、`Research Path Vs Production Path`、`Upstream Reporting Responsibilities`、`Monthly Codex Remediation`、`Standard Monthly Flow`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
11+
312
## Scope
413

514
This runbook covers the production release path for `CryptoSnapshotPipelines`.

‎docs/validation_status.md‎

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

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `Validation Status`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Frozen Default`、`Current Strategy Validation Snapshot`、`Publish Chain Validation Completed`、`External Data Preparation Validation Completed`、`Not Finished Yet`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
311
This document tracks the current frozen production decision and what still remains experimental.
412

513
## Frozen Default

0 commit comments

Comments
 (0)