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
2 changes: 1 addition & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ UsEquityStrategies 是 QuantStrategyLab 的美股策略包。为 QuantStrategyLa
- **策略包**:保存可复用策略代码、元数据和运行入口。
- **Snapshot 流水线**:生成 feature snapshot、ranking、回测和发布证据。
- **执行平台**:把策略接到券商、dry-run 检查、通知和 live 部署控制。
- **共享基础设施**:沉淀契约、配置、适配器、插件和审计 workflow,供多仓复用。
- **共享基础设施**:维护契约、配置、适配器、插件和审计 workflow,供多仓复用。

本仓库负责策略代码和元数据,不保存券商凭据,不直接提交订单,也不替代 live enable 前需要看的 snapshot 和回测证据。

Expand Down
8 changes: 0 additions & 8 deletions docs/research/global_etf_confidence_vol_gate.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Global ETF Confidence Vol Gate Research


## 中文摘要

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

## Candidate
Expand Down
9 changes: 1 addition & 8 deletions docs/research/income_layer_design.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
# Income Layer Design Conclusions

[简体中文](income_layer_design.zh-CN.md)

## 中文摘要

- 完整中文版见 [`income_layer_design.zh-CN.md`](income_layer_design.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
- 用途:本文档围绕 `Income Layer Design Conclusions`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Decision`、`Design Rules`、`Leveraged Profile Review`、`Core Default Review`、`Reading the Defaults`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
_Updated: 2026-06-04_

## Decision
Expand Down
10 changes: 1 addition & 9 deletions docs/research/income_layer_design.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# 收入层设计研究结论


## English summary

- Full English version: [`income_layer_design.md`](income_layer_design.md). This summary keeps an English entry point in the Chinese file.
- Purpose: this document covers `收入层设计研究结论` for `UsEquityStrategies`.
- 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](income_layer_design.md)

_更新日期:2026-06-04_

Expand Down
8 changes: 0 additions & 8 deletions docs/research/mega_cap_leader_rotation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# mega_cap_leader_rotation research brief


## 中文摘要

- 用途:本文档围绕 `mega_cap_leader_rotation research brief`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Objective`、`Research And Runtime Scope`、`Signal Design`、`Retained Runtime Shape`、`Research Commands`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
Status: the static `mag7` / `expanded` variants remain research/backtest only.
`mega_cap_leader_rotation_top50_balanced` is the retained runtime-enabled
Top50 candidate. Narrow Top20 and aggressive Top50 profile exposure was removed
Expand Down
9 changes: 0 additions & 9 deletions docs/research/nasdaq_sp500_smart_dca.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Nasdaq/S&P 500 Smart DCA Design


## 中文摘要

- 用途:本文档围绕 `Nasdaq/S&P 500 Smart DCA Design`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Purpose`、`Research Basis`、`Default Instruments`、`Cadence`、`Sizing Rules`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。

## Purpose

`nasdaq_sp500_smart_dca` is a buy-only accumulation profile for cash-funded
Expand Down
8 changes: 0 additions & 8 deletions docs/us_equity_contract_gap_matrix.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# US equity contract gap matrix


## 中文摘要

- 用途:本文档围绕 `US equity contract gap matrix`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Current Runtime Scope`、`Removed Research Profile Exposure`、`Canonical Input Vocabulary`、`Profile Matrix`、`Current Conclusions`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
_Updated: 2026-06-04_

This document tracks the current shared US equity strategy contract across
Expand Down
9 changes: 1 addition & 8 deletions docs/us_equity_notification_i18n_contract.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
# US Equity Notification, i18n, and Log Contract

[简体中文](us_equity_notification_i18n_contract.zh-CN.md)

## 中文摘要

- 完整中文版见 [`us_equity_notification_i18n_contract.zh-CN.md`](us_equity_notification_i18n_contract.zh-CN.md);本节保留在英文文件顶部,方便从当前文件直接找到中文入口。
- 用途:本文档围绕 `US Equity Notification, i18n, and Log Contract`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Strategy Output`、`i18n Rules`、`Rendered Display Fields`、`Required Log Fields`、`Sidecar Plugin Messages`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
_Updated: 2026-05-29_

This document defines the strategy-layer payload shape that downstream platform repositories should use for Telegram messages, dry-run reports, and audit logs. Strategy code owns structured facts and translation keys; platform repositories own final layout, routing, and compaction.
Expand Down
10 changes: 1 addition & 9 deletions docs/us_equity_notification_i18n_contract.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
# 美股策略通知、i18n 与日志契约


## English summary

- Full English version: [`us_equity_notification_i18n_contract.md`](us_equity_notification_i18n_contract.md). This summary keeps an English entry point in the Chinese file.
- Purpose: this document covers `美股策略通知、i18n 与日志契约` for `UsEquityStrategies`.
- Main topics: `策略输出位置`, `i18n 规则`, `已渲染展示字段`, `日志格式`, `侧车插件通知文案`.
- 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](us_equity_notification_i18n_contract.md)

_更新日期:2026-05-29_

Expand Down
8 changes: 0 additions & 8 deletions docs/us_equity_portability_checklist.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# US equity portability checklist


## 中文摘要

- 用途:本文档围绕 `US equity portability checklist`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`1. Contract registration`、`2. Canonical inputs only`、`3. Output portability`、`4. Runtime-adapter matrix`、`5. Artifact-backed profiles`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
Use this checklist before enabling a US equity profile on any runtime.

This document is intentionally shorter than the authoring template. It is a reviewer-facing list for portability sign-off.
Expand Down
9 changes: 0 additions & 9 deletions docs/us_equity_runtime_archive.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# US equity runtime archive


## English summary

- Purpose: this document covers `US equity runtime archive` for `UsEquityStrategies`.
- 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.

_更新日期:2026-06-03_

这份索引只记录当前 `runtime_enabled` 的美股 profile 及其可复查证据。
Expand Down
9 changes: 0 additions & 9 deletions docs/us_equity_strategy_status.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# 美股策略状态与研究手册


## English summary

- Purpose: this document covers `美股策略状态与研究手册` for `UsEquityStrategies`.
- Main topics: `当前可配置 profiles`, `已移除的重复/较弱研究 profile 暴露`, `收入层默认启用口径`, `已归档回测摘要`, `研究中但未进入运行 profile 的方向`.
- 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.

_更新日期:2026-06-04_

这份文档只记录当前可配置的美股策略 profile、输入形态和研究状态,不记录任何账户或服务正在运行的 profile。部署单元当前跑什么属于私有运行信息,应留在云端配置或私有运行记录里。
Expand Down
8 changes: 0 additions & 8 deletions docs/us_equity_strategy_template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# US equity strategy template


## 中文摘要

- 用途:本文档围绕 `US equity strategy template`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`What “done” looks like`、`Minimal repository footprint`、`1. Profile metadata and catalog registration`、``StrategyDefinition` must declare`、`Example`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
This document is the authoring template for **new** US equity strategy profiles in `UsEquityStrategies`.

It is aligned with:
Expand Down
12 changes: 2 additions & 10 deletions docs/us_equity_value_mode_input_contract.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# US equity value-mode canonical input contract


## 中文摘要

- 用途:本文档围绕 `US equity value-mode canonical input contract`,用于理解 `UsEquityStrategies` 的配置、运行、部署、研究或验收边界。
- 主要覆盖:`Why this document exists`、`Fixed end-state summary`、`Shared contract rules for value-mode profiles`、`1. Canonical required inputs`、`2. Canonical portfolio object`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。
This document fixes the **strategy-facing canonical input contract** for the
current US equity value-mode profiles:

Expand All @@ -32,8 +24,8 @@ strategy-facing canonical inputs:
- `soxl_soxx_trend_income` uses `derived_indicators` + `portfolio_snapshot`
- `nasdaq_sp500_smart_dca` uses `market_history` + `portfolio_snapshot`

This document defines the end-state contract that later P2/P4 code changes
should implement.
This document records the fixed value-mode input contract and the current
implementation status.

Current implementation status:

Expand Down