QuantDinger Documentation¶
This directory contains maintained documentation for the current QuantDinger release. Start with the project README or the Chinese project README.
Architecture and contracts¶
| Document | Purpose |
|---|---|
| Architecture | Backend ownership map and contributor design rules. |
| Module boundaries | Dependency direction and package responsibilities. |
| Concurrency model | Database, worker, and thread ownership rules. |
| Process roles | API, trading, scheduler, Celery, and migration boundaries. |
| API conventions | Human API envelopes, authentication, and stability classes. |
| Extension guide | How to add routes, services, adapters, and tasks safely. |
Deployment and operations¶
| Document | Purpose |
|---|---|
| Production hardening | Locked runtime and production preflight. |
| Observability | Prometheus, Grafana, Alertmanager, and exporters. |
| Installation troubleshooting | Docker, mirrors, ports, and PostgreSQL problems. |
| Cloud deployment (English) | Reverse proxy and cloud deployment. |
| 云部署（中文） | 反向代理与云部署。 |
| Multi-user setup | Roles and multi-user deployment. |
| OAuth (English) | Google and GitHub OAuth configuration. |
| OAuth（中文） | Google 与 GitHub OAuth 配置。 |
| USDT payment | Optional USDT billing configuration. |
Notification configuration:
Trading and research¶
| Document | Purpose |
|---|---|
| Indicator guide | Chart-only Python indicator contract. |
| 指标指南 | 图表指标开发契约。 |
| Strategy guide | Strategy API V2, risk, backtest, and live execution. |
| 策略指南 | 脚本策略、风控、回测与实盘。 |
| Public universes and fundamentals | 股票池来源、时点数据和已知限制。 |
| IBKR guide | IBKR connectivity and trading workflow. |
Runnable examples are in examples/.
API and AI agents¶
api/contains the generated human OpenAPI contract and ReDoc viewer.agent/contains Agent Gateway, MCP, security, and integration docs.mcp_server/contains the standalone MCP package.
Maintenance policy¶
- Keep one maintained document for each operational or architectural concern.
- Put implementation decisions in architecture or contract documents, not in one-off planning files.
- Do not commit temporary audits, validation snapshots, generated screenshots, or completed roadmaps. Git history already preserves them.
- Update links and the relevant index in the same change when a document moves.
- Keep generated OpenAPI artifacts committed because CI checks them.