Files
miles/docs/developer/index.md
T
04b61f31a1 Migrate documentation into docs/ with full history (#1321)
Co-authored-by: Zhichen Zeng <zczeng@uw.edu>
Co-authored-by: Shi Dong <shi.dong@radixark.ai>
Co-authored-by: Yueming Yuan <yym022502@gmail.com>
Co-authored-by: Shi-Dong <Shi-Dong@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Ethan (Yusheng) Su <yushengsu.thu@gmail.com>
Co-authored-by: Haoguang Cai <kai.cai@radixark.ai>
Co-authored-by: Mingyi Lu <wisclmy0611@gmail.com>
Co-authored-by: Jiajun Li <guapisolo@gmail.com>
2026-06-12 13:38:50 -07:00

1.4 KiB

title, description
title description
Developer Guide Architecture, contribution conventions, debugging, and migration notes.

You're here because you want to change Miles, not just use it. This section is the short tour for new contributors.

PR conventions, code layout, how reviews work.
Aligning precision, separate train/rollout debugging, common kernel pitfalls.
Sync → async loop, breaking flag changes between releases.
The 30-minute tour of how Miles is organized internally.
Opt-in backends and features (FSDP, …) that aren't production-ready yet.

TL;DR for first-time contributors

  1. Pick something small from good first issue on GitHub.
  2. Run the Reproducibility recipe so you can be sure "I changed X and it broke" actually means that.
  3. Use --debug-train-only or --debug-rollout-only to scope your changes.
  4. Open a PR. We'll review within ~48h.