New developers should follow the developer reading path. Commands in these guides run from the repository root unless stated otherwise.
| Guide | Use it when |
|---|---|
| Getting started | Setting up a checkout and choosing a safe run mode. |
| Architecture | Finding the owner of a feature or tracing a request. |
| Conventions | Writing code that fits the project. |
| Testing | Choosing checks and interpreting their results. |
| Contributing | Reporting an issue or preparing a change for review. |
| Debugging | Diagnosing failures and managing local output. |
| Releases | Understanding versions, CI, and release operations. |
| Sentry | Configuring crash reporting for a build. |
- Track analysis settings: choosing stages and queuing a batch.
- USB export: compatibility conversion and playlist cleanup.
- Backups: backup contents, storage, and restoration.
- Waveform scrubbing: drag behavior and its audio filter.
- AppleScript: macOS automation, objects, commands, and examples.
- Nix: installing, running, developing, and removing the flake.
- Library location: which rekordbox library opens, switching it in Database management, and missing drives.
- USB export format: files, binary records, implementation, verification, and unknowns.
- USB export pipeline: how an export and selective sync run from the Sync Manager to the stick, their safety checks and recovery, what has been validated, and where to change it.
- Library backups: how backups are created and restored, and why.
- Keyboard commands: how a key, a menu item and a button run one shared command, and the audit of every bound action against rekordbox's menu bar.
- LINK behavior and hardware coverage: device dialects, behavior catalog, and physical checks.
- Analysis crate: algorithm reading path and evaluation tools.
- Waveform calibration: measured overview behavior and its limits.
- Playback crate: thread model, code map, and test workflow.
- Playback test fixtures: generated audio and regeneration.
- Licensing: bundled library terms.
The sibling rbxport-private checkout contains firmware harnesses, private test
assets, captures, and investigations. Run registered suites through
npm run tests:private in this checkout. The private repository's README
explains its layout; its verification/ directory holds local run evidence.
Keep credentials, installed library backups, and copyrighted test audio out
of the public repository.
assets/brand/ contains the app icons, graphics, wordmarks, combined logos,
and reference board. See its README.txt for format details. The centered
README logo uses the existing color/white lockup.