Skip to content

Add bilingual docs summaries #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Pigbibi wants to merge 1 commit into from
Closed

Add bilingual docs summaries #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
10 changes: 10 additions & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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。
Expand Down
8 changes: 8 additions & 0 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
9 changes: 9 additions & 0 deletions docs/external_data_roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 8 additions & 0 deletions docs/external_data_validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
8 changes: 8 additions & 0 deletions docs/integration_contract.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
9 changes: 9 additions & 0 deletions docs/operator_runbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.
Expand Down
8 changes: 8 additions & 0 deletions docs/validation_status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down