Skip to content

Commit 725283e

Browse files
PigbibiPigbibi
authored
Merge pull request #1 from QuantStrategyLab/codex/bilingual-docs-20260601
Add bilingual docs summaries
2 parents 2e4b3d8 + c24a6e3 commit 725283e

6 files changed

Lines changed: 54 additions & 0 deletions

File tree

‎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+
- 用途：本文档围绕 `PoliticalEventTrackingResearch`，用于理解 `PoliticalEventTrackingResearch` 的配置、运行、部署、研究或验收边界。
10+
- 主要覆盖：`Repository Role`、`Current Status`、`Local Validation`、`Data Contracts`、`Live Pipeline Notes`。
11+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
12+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
13+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
514
[English](README.md) | [简体中文](README.zh-CN.md)
615

716
Research-only political event and public disclosure tracking for US equities.

‎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 `PoliticalEventTrackingResearch` for `PoliticalEventTrackingResearch`.
10+
- Main topics: `仓库定位`, `当前状态`, `本地验证`, `Live pipeline 说明`, `研究判断`.
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) | [简体中文](README.zh-CN.md)
616

717
QuantStrategyLab 的确定性研究仓库，用来验证“公开持仓/交易披露 + 官方讲话/公开材料 + 政策资金事件”能否形成可追踪的美股事件线索。

‎docs/free_source_setup.zh-CN.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# 免费数据源配置
22

3+
4+
## English summary
5+
6+
- Purpose: this document covers `免费数据源配置` for `PoliticalEventTrackingResearch`.
7+
- Main topics: `已落地文件`, `当前稳定版保留的数据源`, `暂缓的数据源`, `推荐运营流程`, `长线证据边界`.
8+
- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches.
9+
- 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.
10+
- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body.
11+
312
## 已落地文件
413

514
- `config/free_rss_feeds.csv`：无需账号的官方 RSS 源。

‎docs/research_plan.zh-CN.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# 政治事件追踪研究计划
22

3+
4+
## English summary
5+
6+
- Purpose: this document covers `政治事件追踪研究计划` for `PoliticalEventTrackingResearch`.
7+
- Main topics: `目标`, `研究单元`, `事件分层`, `数据源优先级`, `原始文本抽取入口`.
8+
- Read the boundaries, inputs, outputs, and permission requirements before running commands, CI jobs, dry-runs, releases, or runtime switches.
9+
- 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.
10+
- If this summary differs from the detailed Chinese body, follow the concrete commands, configuration keys, and constraints in the body.
11+
312
## 目标
413

514
验证公开人物持仓披露、官方公开点名、政策资金事件与美股短中期收益之间是否存在可复现关系。

‎docs/source_ingestion_options.md‎

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

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

514
The stable ingestion path is:

‎docs/source_registry.md‎

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

3+
4+
## 中文摘要
5+
6+
- 用途：本文档围绕 `Source Registry`，用于理解 `PoliticalEventTrackingResearch` 的配置、运行、部署、研究或验收边界。
7+
- 主要覆盖：`Candidate Official Sources`、`Candidate Issuer Sources`、`Candidate Lead Sources`、`Deferred Sources`、`Current Configured RSS Feeds`。
8+
- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。
9+
- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。
10+
- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。
311
This file records source families for the stable research release. A source
412
listed here is not automatically trusted; every event still carries its own
513
`source_url` and `confidence`.

0 commit comments

Comments
 (0)