From c24a6e3c20fa521b3aba631e96d2ce687f5b3a03 Mon Sep 17 00:00:00 2001 From: Pigbibi <20649888+Pigbibi@users.noreply.github.com> Date: Mon, 1 Jun 2026 03:48:10 +0800 Subject: [PATCH] Add bilingual docs summaries --- README.md | 9 +++++++++ README.zh-CN.md | 10 ++++++++++ docs/free_source_setup.zh-CN.md | 9 +++++++++ docs/research_plan.zh-CN.md | 9 +++++++++ docs/source_ingestion_options.md | 9 +++++++++ docs/source_registry.md | 8 ++++++++ 6 files changed, 54 insertions(+) diff --git a/README.md b/README.md index 025b001..3d800b3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ > ⚠️ 投资有风险，不构成投资建议，仅供学习交流用途。 + +## 中文摘要 + +- 完整中文版见 [`README.zh-CN.md`](README.zh-CN.md)；本节保留在英文文件顶部，方便从当前文件直接找到中文入口。 +- 用途：本文档围绕 `PoliticalEventTrackingResearch`，用于理解 `PoliticalEventTrackingResearch` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Repository Role`、`Current Status`、`Local Validation`、`Data Contracts`、`Live Pipeline Notes`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 [English](README.md) | [简体中文](README.zh-CN.md) Research-only political event and public disclosure tracking for US equities. diff --git a/README.zh-CN.md b/README.zh-CN.md index d58cd33..88a9ab2 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 `PoliticalEventTrackingResearch` for `PoliticalEventTrackingResearch`. +- Main topics: `仓库定位`, `当前状态`, `本地验证`, `Live pipeline 说明`, `研究判断`. +- 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) | [简体中文](README.zh-CN.md) QuantStrategyLab 的确定性研究仓库，用来验证“公开持仓/交易披露 + 官方讲话/公开材料 + 政策资金事件”能否形成可追踪的美股事件线索。 diff --git a/docs/free_source_setup.zh-CN.md b/docs/free_source_setup.zh-CN.md index dea4825..2145dc7 100644 --- a/docs/free_source_setup.zh-CN.md +++ b/docs/free_source_setup.zh-CN.md @@ -1,5 +1,14 @@ # 免费数据源配置 + +## English summary + +- Purpose: this document covers `免费数据源配置` for `PoliticalEventTrackingResearch`. +- 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. + ## 已落地文件 - `config/free_rss_feeds.csv`：无需账号的官方 RSS 源。 diff --git a/docs/research_plan.zh-CN.md b/docs/research_plan.zh-CN.md index aea7bd6..6e78e21 100644 --- a/docs/research_plan.zh-CN.md +++ b/docs/research_plan.zh-CN.md @@ -1,5 +1,14 @@ # 政治事件追踪研究计划 + +## English summary + +- Purpose: this document covers `政治事件追踪研究计划` for `PoliticalEventTrackingResearch`. +- 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. + ## 目标 验证公开人物持仓披露、官方公开点名、政策资金事件与美股短中期收益之间是否存在可复现关系。 diff --git a/docs/source_ingestion_options.md b/docs/source_ingestion_options.md index c390331..9bed9e7 100644 --- a/docs/source_ingestion_options.md +++ b/docs/source_ingestion_options.md @@ -1,5 +1,14 @@ # Source Ingestion Options + +## 中文摘要 + +- 用途：本文档围绕 `Source Ingestion Options`，用于理解 `PoliticalEventTrackingResearch` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Summary`、`Stable Sources`、`Deferred Sources`、`Implementation Notes`、`Operational Caveats`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 + ## Summary The stable ingestion path is: diff --git a/docs/source_registry.md b/docs/source_registry.md index d48878a..8de21bf 100644 --- a/docs/source_registry.md +++ b/docs/source_registry.md @@ -1,5 +1,13 @@ # Source Registry + +## 中文摘要 + +- 用途：本文档围绕 `Source Registry`，用于理解 `PoliticalEventTrackingResearch` 的配置、运行、部署、研究或验收边界。 +- 主要覆盖：`Candidate Official Sources`、`Candidate Issuer Sources`、`Candidate Lead Sources`、`Deferred Sources`、`Current Configured RSS Feeds`。 +- 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 +- 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 +- 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 This file records source families for the stable research release. A source listed here is not automatically trusted; every event still carries its own `source_url` and `confidence`.