Skip to content

Commit 29d8079

Browse files
authored
docs: rewrite open-source readmes
Rewrite the README pair as separate English and Chinese open-source project entry points.
1 parent 5e1ffc0 commit 29d8079

2 files changed

Lines changed: 44 additions & 78 deletions

File tree

README.md

Lines changed: 22 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,63 +2,46 @@
22

33
[Chinese README](README.zh-CN.md)
44

5-
> ⚠️ Investing involves risk. This project does not provide investment advice and is for educational and research purposes only.
5+
> Investing involves risk. This project does not provide investment advice and is for education, research, and engineering review only.
66
7-
## What this project does
7+
## What this repository is
88

9-
QuantAdvisorResearch is a **Research advisory system** in the QuantStrategyLab ecosystem. It publishes research-oriented advisory content from web/RSS evidence without placing orders or providing account-specific advice.
9+
QuantAdvisorResearch is a QuantStrategyLab research publishing system. It publishes research-oriented advisory content from web and RSS evidence without placing orders.
1010

11-
## Who this is for
11+
It produces research, audit, or orchestration artifacts. It should not submit broker orders or mutate live allocations by itself.
1212

13-
- Engineers and researchers who want to inspect, reproduce, or extend this part of the QuantStrategyLab stack.
14-
- Operators who need a clear entry point before reading the deeper runbooks or workflow files.
15-
- Reviewers who need to understand the repository purpose, safety boundary, and evidence requirements before enabling automation.
13+
## Output boundary
1614

17-
## Current status
18-
19-
Research and publishing system; outputs require human review before use.
15+
- Treat generated reports as evidence or review material, not automatic trading instructions.
16+
- Keep source traceability and artifact timestamps visible.
17+
- Require human review before using outputs in downstream strategy or platform changes.
18+
- Keep credentials, private data, and external service tokens out of Git and logs.
2019

2120
## Repository layout
2221

23-
- `src/`: main library and runtime code.
24-
- `tests/`: unit and contract tests.
25-
- `docs/`: detailed design notes, runbooks, and evidence docs.
26-
- `.github/workflows/`: CI, scheduled jobs, and deployment workflows.
22+
- `src/`: library and runtime code.
23+
- `tests/`: unit, contract, and regression tests.
24+
- `docs/`: runbooks, design notes, evidence, and integration contracts.
25+
- `.github/workflows/`: CI, scheduled jobs, release, or deployment workflows.
2726
- `scripts/`: operator scripts and local helpers.
2827

2928
## Quick start
3029

31-
From a fresh clone:
32-
3330
```bash
3431
python -m pip install -e .
3532
python -m pytest -q
3633
```
3734

38-
If a command requires credentials, run it only after reading the relevant workflow or runbook and configuring secrets outside Git.
39-
40-
## Deployment and operation
41-
42-
Configure data sources, publishing credentials, and scheduled workflows. Start with a manual run, inspect generated content and citations, then enable schedule.
43-
44-
Prefer manual or dry-run execution first. Enable schedules or live execution only after logs, artifacts, permissions, and rollback steps are reviewed.
45-
46-
## Strategy performance and evidence
47-
48-
Not a trading strategy repository. Evaluate it by evidence quality, citation accuracy, freshness, and whether outputs avoid account-specific investment advice.
49-
50-
README files are intentionally not a source of dated performance promises. Re-run the relevant tests, backtests, or pipeline jobs before relying on any result.
51-
52-
## Safety notes
53-
54-
- Never commit API keys, broker credentials, OAuth tokens, cookies, or account identifiers.
55-
- Run new strategies and platform changes in dry-run or paper mode before any live execution.
56-
- Review generated orders, artifacts, and logs manually before enabling schedules.
57-
58-
## Contributing
35+
## Useful docs
5936

60-
Keep changes small, reproducible, and covered by the narrowest useful tests. For strategy-facing changes, include the evidence artifact or command used to validate behavior.
37+
- [`docs/advisory_contract.md`](docs/advisory_contract.md)
38+
- [`docs/data_factor_roadmap.md`](docs/data_factor_roadmap.md)
39+
- [`docs/data_factor_roadmap.zh-CN.md`](docs/data_factor_roadmap.zh-CN.md)
40+
- [`docs/notification_format.md`](docs/notification_format.md)
41+
- [`docs/notification_format.zh-CN.md`](docs/notification_format.zh-CN.md)
42+
- [`docs/system_design.md`](docs/system_design.md)
43+
- [`docs/system_design.zh-CN.md`](docs/system_design.zh-CN.md)
6144

6245
## License
6346

64-
See [LICENSE](LICENSE) if present in this repository.
47+
See [LICENSE](LICENSE).

README.zh-CN.md

Lines changed: 22 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,63 +2,46 @@
22

33
[English README](README.md)
44

5-
> ⚠️ 投资有风险,不构成投资建议,仅供学习交流用途
5+
> 投资有风险。本项目不构成投资建议,仅用于学习、研究和工程审阅
66
7-
## 这个项目做什么
7+
## 这个仓库是什么
88

9-
QuantAdvisorResearch 是 QuantStrategyLab 体系中的**研究顾问系统**。基于网页/RSS 证据发布研究型顾问内容,不下单,也不提供面向具体账户的建议
9+
QuantAdvisorResearch 是 QuantStrategyLab 的研究发布系统。基于网页和 RSS 证据发布研究型内容,不执行订单
1010

11-
## 适合谁使用
11+
它产出研究、审计或编排类 artifact,不应自行提交券商订单,也不应直接修改 live allocation。
1212

13-
- 希望阅读、复现或扩展 QuantStrategyLab 相关模块的工程师和研究人员。
14-
- 在阅读详细 runbook 或 workflow 前,需要先理解项目入口的运维人员。
15-
- 在启用自动化前,需要确认项目职责、安全边界和证据要求的 reviewer。
13+
## 输出边界
1614

17-
## 当前状态
18-
19-
研究与发布系统;输出内容使用前需要人工复核。
15+
- 生成报告应作为证据或审阅材料,不是自动交易指令。
16+
- 保留来源可追溯性和 artifact 时间戳。
17+
- 输出用于下游策略或平台改动前,需要人工 review。
18+
- 凭据、私人数据和外部服务 token 不能提交到 Git,也不能写入日志。
2019

2120
## 仓库结构
2221

23-
- `src/`主要库代码和运行时代码
24-
- `tests/`单元测试和契约测试
25-
- `docs/`详细设计说明、运行手册和证据文档
26-
- `.github/workflows/`:CI、定时任务和部署 workflow。
22+
- `src/`库代码和运行时代码
23+
- `tests/`单元测试、契约测试和回归测试
24+
- `docs/`运行手册、设计说明、证据和集成契约
25+
- `.github/workflows/`:CI、定时任务、发布或部署 workflow。
2726
- `scripts/`:运维脚本和本地辅助工具。
2827

2928
## 快速开始
3029

31-
从全新 clone 开始:
32-
3330
```bash
3431
python -m pip install -e .
3532
python -m pytest -q
3633
```
3734

38-
如果命令需要凭据,请先阅读相关 workflow 或 runbook,并把密钥配置在 Git 之外。
39-
40-
## 部署和运行
41-
42-
配置数据源、发布凭据和定时 workflow。先手工运行,检查生成内容和引用,再启用定时任务。
43-
44-
建议先手工运行或 dry-run。只有在日志、产物、权限和回滚步骤都检查过之后,才启用定时任务或 live 执行。
45-
46-
## 策略表现与证据边界
47-
48-
这不是交易策略仓库。评估重点是证据质量、引用准确性、时效性,以及是否避免具体账户投资建议。
49-
50-
README 不应该承诺固定收益或过期指标。实际使用前,请重新运行对应测试、回测或流水线任务。
51-
52-
## 安全注意事项
53-
54-
- 不要把 API key、券商凭据、OAuth token、Cookie 或账户标识提交到 Git。
55-
- 新策略或平台变更在 live 前必须先跑 dry-run 或 paper 流程。
56-
- 启用定时任务前,需要人工检查生成的订单、产物和日志。
57-
58-
## 参与贡献
35+
## 延伸文档
5936

60-
请保持改动小、可复现,并用最小必要测试覆盖。涉及策略的改动,需要附上验证行为的证据产物或命令。
37+
- [`docs/advisory_contract.md`](docs/advisory_contract.md)
38+
- [`docs/data_factor_roadmap.md`](docs/data_factor_roadmap.md)
39+
- [`docs/data_factor_roadmap.zh-CN.md`](docs/data_factor_roadmap.zh-CN.md)
40+
- [`docs/notification_format.md`](docs/notification_format.md)
41+
- [`docs/notification_format.zh-CN.md`](docs/notification_format.zh-CN.md)
42+
- [`docs/system_design.md`](docs/system_design.md)
43+
- [`docs/system_design.zh-CN.md`](docs/system_design.zh-CN.md)
6144

6245
## 许可证
6346

64-
如仓库包含 [LICENSE](LICENSE),请以该文件为准
47+
详见 [LICENSE](LICENSE)

0 commit comments

Comments
 (0)