The same chapters served from the in-app Help → Manual… window.
The files in this folder are the single source of truth: they render here on GitHub for browsing on the web, and they are embedded into the binary at compile time via include_str! (src/manual.rs) so the running app shows byte-identical content. Edit any chapter and it updates both surfaces on the next build.
- Welcome — what TinyBooth is, philosophy in one sentence, where things live on disk.
- Getting started — first-run walkthrough; mic to saved take in five minutes.
- Recording — the Record tab in detail.
- Recording tones — the Profile / FilterChain system, presets.
- Editing profiles (Admin) — every parameter the Admin window exposes.
- Projects — the
.tinyboothproject format and the Project tab. - Export — formats, mixdown, ffmpeg discovery.
- Importing Suno stems — folder + zip ingestion, role tagging.
- Self-update — the in-app updater wired to GitHub Releases.
- Mix tab — remastering — multitrack playback, per-track correction, A/B bypass.
- Using this manual — how the Help window itself works.
- Troubleshooting
- File formats —
project.tinybooth,profiles.json,config.json, track WAV specs, Suno-stem filename mapping.
If you spot a typo or want to extend a chapter, the pages are plain Markdown. Open a PR; the next tagged release will ship the updated text both in this folder and inside the in-app manual. No separate documentation pipeline.
User-facing documentation lives here. For developers and contributors, sibling docs cover:
../architecture.md— application anatomy and threading model../rust-survival-guide.md— Rust patterns for industrial-grade desktop apps../audit/— periodic codebase audits with categorised findings../feature-requests/— formal RFCs for past and proposed features