Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 0 additions & 9 deletions docs/advisory_contract.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Intelligent Advisory Artifact Contract


## 中文摘要

- 用途:本文档围绕 `Intelligent Advisory Artifact Contract`,用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Report`、`Policy`、`Recommendation`、`Theme-first Candidate`、`Final Decisions`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。

## Report

Required top-level fields:
Expand Down
9 changes: 0 additions & 9 deletions docs/data_factor_roadmap.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Data Source and Factor Roadmap


## 中文摘要

- 完整中文版见 [`data_factor_roadmap.zh-CN.md`](data_factor_roadmap.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
- 用途:本文档围绕 `Data Source and Factor Roadmap`,用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Current Direction`、`Current Inputs`、`PoliticalEventTrackingResearch`、`ResearchSignalContextPipelines`、`QuantAdvisorResearch`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
[English](data_factor_roadmap.md) | [简体中文](data_factor_roadmap.zh-CN.md)

## Current Direction
Expand Down
10 changes: 0 additions & 10 deletions docs/data_factor_roadmap.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
# 数据源与因子完善路线


## English summary

- Full English version: [`data_factor_roadmap.md`](data_factor_roadmap.md). This summary keeps an English entry point in the Chinese file.
- Purpose: this document covers `数据源与因子完善路线` for `QuantAdvisorResearch`.
- Main topics: `当前结论`, `现有数据源盘点`, `PoliticalEventTrackingResearch`, `ResearchSignalContextPipelines`, `QuantAdvisorResearch`.
- 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](data_factor_roadmap.md) | [简体中文](data_factor_roadmap.zh-CN.md)

## 当前结论
Expand Down
10 changes: 1 addition & 9 deletions docs/notification_format.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# 智慧投顾研究通知格式


## English summary

- Full English version: [`notification_format.md`](notification_format.md). This summary keeps an English entry point in the Chinese file.
- Purpose: this document covers `智慧投顾研究通知格式` for `QuantAdvisorResearch`.
- Main topics: `设计原则`, `通用字段`, `RSS 摘要`, `Telegram 摘要`, `邮件摘要`.
- 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](notification_format.md)

## 设计原则

Expand Down
9 changes: 0 additions & 9 deletions docs/system_design.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Intelligent Advisory Research System Design


## 中文摘要

- 完整中文版见 [`system_design.zh-CN.md`](system_design.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
- 用途:本文档围绕 `Intelligent Advisory Research System Design`,用于理解 `QuantAdvisorResearch` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Architecture`、`Data Flow`、`Horizon Ownership`、`Design Patterns`、`Publishing Cadence`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
[English](system_design.md) | [简体中文](system_design.zh-CN.md)

## Architecture
Expand Down
10 changes: 0 additions & 10 deletions docs/system_design.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
# 智慧投顾研究系统设计


## English summary

- Full English version: [`system_design.md`](system_design.md). This summary keeps an English entry point in the Chinese file.
- Purpose: this document covers `智慧投顾研究系统设计` for `QuantAdvisorResearch`.
- Main topics: `当前架构理解`, `智慧投顾研究数据流`, `设计模式`, `不推荐方案`, `MVP 验证标准`.
- 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](system_design.md) | [简体中文](system_design.zh-CN.md)

## 当前架构理解
Expand Down