diff --git a/README.md b/README.md index 4e8cad7..51452b5 100644 --- a/README.md +++ b/README.md @@ -282,6 +282,19 @@ For crashes or unexplained failures during backtest/compile/optimization: **[Full Troubleshooting Guide →](docs/TROUBLESHOOTING.md)** +## Documentation + +| Doc | Description | +|-----|-------------| +| [QUICKSTART](docs/QUICKSTART.md) | Step-by-step install, setup, and first backtest | +| [MCP_TOOLS](docs/MCP_TOOLS.md) | Full input/output schemas for all 90 tools | +| [CONFIG](docs/CONFIG.md) | Configuration reference (`config/mt5-quant.yaml`) | +| [ARCHITECTURE](docs/ARCHITECTURE.md) | Design principles and internal module layout | +| [REMOTE_AGENTS](docs/REMOTE_AGENTS.md) | Distribute optimization across Linux agents via Wine | +| [TROUBLESHOOTING](docs/TROUBLESHOOTING.md) | Platform-specific fixes for Wine, MT5, and backtests | + +Full index with reading order: [docs/INDEX.md](docs/INDEX.md) + --- ## Acknowledgements diff --git a/docs/INDEX.md b/docs/INDEX.md new file mode 100644 index 0000000..eef0ac1 --- /dev/null +++ b/docs/INDEX.md @@ -0,0 +1,23 @@ +# Documentation Index + +**Start here:** [QUICKSTART.md](QUICKSTART.md) — install MT5-Quant, run `scripts/setup.sh` to auto-detect Wine/MT5 paths, register it with your LLM client, and complete your first backtest. + +| Doc | Description | +|-----|-------------| +| [QUICKSTART.md](QUICKSTART.md) | Step-by-step install, setup, and first backtest | +| [MCP_TOOLS.md](MCP_TOOLS.md) | Full input/output schemas for all 90 tools | +| [CONFIG.md](CONFIG.md) | Configuration reference (`config/mt5-quant.yaml`) | +| [ARCHITECTURE.md](ARCHITECTURE.md) | Design principles and internal module layout | +| [REMOTE_AGENTS.md](REMOTE_AGENTS.md) | Distribute optimization across Linux agents via Wine | +| [TROUBLESHOOTING.md](TROUBLESHOOTING.md) | Platform-specific fixes for Wine, MT5, and backtests | + +## Suggested reading order + +1. [QUICKSTART.md](QUICKSTART.md) — get a working installation and first report +2. [MCP_TOOLS.md](MCP_TOOLS.md) — browse what your LLM agent can call +3. [CONFIG.md](CONFIG.md) — tune symbols, timeframes, deposit defaults +4. [TROUBLESHOOTING.md](TROUBLESHOOTING.md) — when something fails +5. [ARCHITECTURE.md](ARCHITECTURE.md) — how the pipeline works under the hood +6. [REMOTE_AGENTS.md](REMOTE_AGENTS.md) — scale up optimization throughput + +These files are also bundled in every release tarball and MCP package, so installed copies stay available offline.