docs/ 根目录只保留文档入口。具体文档按用途放入子目录;AI 助手通用入口以 AGENTS.md 为准。
| 目录 | 内容 | 入口 |
|---|---|---|
| rules | 仓库级规则正文 | rules/index.md |
| adr/index.md | 重大治理和架构决策记录 | 0001-rule-source-and-governance-model.md |
| guides | 日常操作、研究流程、环境说明 | research-workflow.md |
| architecture | 平台结构和长期架构说明 | research-platform-architecture.md |
| design | 实施方案、重构方案、治理方案草案 | 本地研究平台重构技术实施方案.md |
| reference | 外部平台资料和分析参考 | joinquant-api.md |
| joinquant-data | 聚宽数据专题资料 | JQ_场内基金数据.md |
| indexes | 机器生成的文档、报告、数据和变体索引 | docs_catalog.json |
| 文档 | 内容 | 备注 |
|---|---|---|
| feishu-relay-tools.md | 聚宽模拟交易飞书通知工具使用说明 | — |
- 新增说明型文档优先放入
guides/、architecture/、design/或reference/。 - 新增或移动文档后运行
.\.venv\Scripts\python.exe -m scripts.tools.path_tools.refactor check。 - 文档和报告索引用
.\.venv\Scripts\python.exe -m scripts.research.docs index重新生成。
commit intent和PR Issue binding audit属于 PR Flow 治理契约,入口见 rules/pr-workflow.md 、rules/governance.md 和 ADR 0007 。