From 62df4a46f5965b0cc6664ef1126f00dfa63419dc Mon Sep 17 00:00:00 2001 From: tinkle-community Date: Mon, 15 Dec 2025 16:05:33 +0800 Subject: [PATCH] docs: add documentation section with architecture links to README --- README.md | 13 +++++++++++++ docs/i18n/zh-CN/README.md | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/README.md b/README.md index 73b70e0b..1fe65f97 100644 --- a/README.md +++ b/README.md @@ -393,6 +393,19 @@ sudo apt-get install libta-lib0-dev --- +## Documentation + +| Document | Description | +|----------|-------------| +| **[Architecture Overview](docs/architecture/README.md)** | System design and module index | +| **[Strategy Module](docs/architecture/STRATEGY_MODULE.md)** | Coin selection, data assembly, AI prompts, execution | +| **[Backtest Module](docs/architecture/BACKTEST_MODULE.md)** | Historical simulation, metrics, checkpoint/resume | +| **[Debate Module](docs/architecture/DEBATE_MODULE.md)** | Multi-AI debate, voting consensus, auto-execution | +| **[FAQ](docs/faq/README.md)** | Frequently asked questions | +| **[Getting Started](docs/getting-started/README.md)** | Deployment guide | + +--- + ## License This project is licensed under **GNU Affero General Public License v3.0 (AGPL-3.0)** - See [LICENSE](LICENSE) file. diff --git a/docs/i18n/zh-CN/README.md b/docs/i18n/zh-CN/README.md index 9b702c4f..8a4f692e 100644 --- a/docs/i18n/zh-CN/README.md +++ b/docs/i18n/zh-CN/README.md @@ -362,6 +362,19 @@ sudo apt-get install libta-lib0-dev --- +## 文档 + +| 文档 | 描述 | +|------|------| +| **[架构概览](../../architecture/README.zh-CN.md)** | 系统设计和模块索引 | +| **[策略模块](../../architecture/STRATEGY_MODULE.md)** | 币种选择、数据组装、AI 提示词、执行 | +| **[回测模块](../../architecture/BACKTEST_MODULE.md)** | 历史模拟、指标计算、断点续测 | +| **[辩论模块](../../architecture/DEBATE_MODULE.md)** | 多 AI 辩论、投票共识、自动执行 | +| **[常见问题](../../faq/README.md)** | FAQ | +| **[快速开始](../../getting-started/README.zh-CN.md)** | 部署指南 | + +--- + ## 许可证 本项目采用 **GNU Affero General Public License v3.0 (AGPL-3.0)** 许可 - 详见 [LICENSE](../../../LICENSE) 文件。