What you control
Desktop app, firmware, diagnostics, and release automation.
Move from first flash to release validation with one consistent documentation surface.
Studio-lab documentation
Ship the tactile mixer experience with a docs hub that feels like the product.
Ioruba turns a low-cost Arduino Nano + 3 knobs into a desktop control instrument. This hub centralizes setup, diagnostics, firmware, and bilingual documentation.
Primary audience
Makers and Linux audio tinkerers.
Clear operational feedback, direct setup steps, and visible failure recovery are prioritized across the site.
Language support
English and PT-BR navigation.
Parallel references for setup, testing, support, and translation work.
Ioruba Documentation
Ioruba is a tactile desktop audio controller built from microcontroller hardware, a cross-platform Tauri app, shared TypeScript domain logic, and native Rust audio backends.
Choose a path below. The Markdown in this repository is the canonical documentation; npm run docs:prepare-site generates the GitHub Pages source from it.
Start here
- README — product overview, platform support, installation, architecture, and repository map
- Quick start — first installation/source build, controller connection, and audio setup
- Hardware setup — wiring, supported boards, knobs, buttons, and encoders
- Arduino Nano setup — compile, flash, and validate the reference controller
Configure and operate
- Profile examples and target matching — current JSON schema, slider targets, controls, and Linux matching rules
- Support playbook — serial, audio, state, update, tray, and platform troubleshooting
- Testing guide — local commands, CI jobs, hardware smoke tests, and release validation
Architecture and maintenance
- Audio backend contract — typed Rust ↔ TypeScript commands and platform dispatch
- Release distribution — release artifacts, signed updater, package managers, macOS signing, and AUR details
- Translation guide — PT-BR source strings, English/Spanish maps, and validation
- Contributing — repository conventions and pull-request checklist
Project status
- Product roadmap — product direction and non-goals
- Executable backlog — open implementation work and completed scrum context
- Changelog — release history
- Funding — ways to support maintenance
Languages
Historical design records
Files under docs/plans/ capture decisions and implementation context at a point in time. They are not current user manuals; use the documents above for present behavior.