A map of the project documentation. Start with the development guide.
- Development Guide — architecture, tech stack, data flow, module layout, and conventions. Start here.
- Runbook — local setup, environment, and how to run the stack.
- Quick Reference — compressed reference card.
- Test Strategy — overall testing approach.
- Test Cases — functional test matrix.
- QA Test Cases — API/endpoint QA matrix.
- E2E — end-to-end test execution guide.
-
How It Works — newcomer tour of the OODA decision loop and the honest backtest result.
-
v2 Backtest Results — honest out-of-sample evaluation of the v2 signal/sizing stack (2019–2024, 14 A-shares). Reproduces with
scripts/backtest_v2_universe.py.
- Research Workstation — the multi-model research
pipeline (
./research.sh): Gemini (sentinel) + Qlib (actuary) + Claude (decision brain).
See also the repository root: README.md,
CONTRIBUTING.md, CHANGELOG.md,
SECURITY.md.