Documentation
Four kinds of document, one page to find them from.
Tech docs for building against the console, an operator manual for driving it, user docs for getting it running, and an FAQ for the straight answer. Tech docs are generated from the running contract wherever the console can generate them; the rest is written by a person and says so when a chapter is not there yet. It all ships with the console, too — a packaged install serves the whole set locally, so a desk with no internet still has its manual.
Tech docs
Reference for developers and integrators.
Generated from the running console's own contract, not hand-written — each one dates itself and cannot describe a control the server does not actually serve.
API reference
/api-docs/
TSDoc for @openmixer/core and the server's public surface, generated with typedoc.
REST reference
/docs/rest
188 addressable rows, their fields, ranges and refusal codes.
OpenAPI 3.1 document
/openapi.json
The same address space as one standard, tool-readable document.
Abstractions catalog
/docs/abstractions
1354 reusable elements — types, composables, components, C libraries — one line each.
The MCP server
/docs/mcp
16 tools over stdio for reading a running console and the tree's own design, and the process skills the repository keeps.
Architecture
/docs/architecture
How the console is built and why: the one summing bus, the row grammar, native DSP against hosted inserts, and the decision records.
The manual
Driving the desk.
The operator manual is published here from the same source the console serves offline, so the pages read online and the pages a desk gives an engineer in a hall with no internet are one document. Its table of contents is its own — follow it into the chapters rather than reading a second copy of it here.
Operator manual
/docs/manual
Every chapter, grouped the way the surface is: the desk, the mix, and running a show — from the fader bay to the keyboard reference.
Installing
/docs/install
What the packages are, what each one puts on the machine, the services that run, and what survives an upgrade.
Troubleshooting
/docs/troubleshooting
Written from the symptom you can observe — a silent main, granulated audio, a box that will not establish — because that is what you have when you need it.
Hardware
/docs/hardware
REAC stageboxes, clocking and sample rate, and the wiring and network-interface mistakes that quietly cost a show.
Administration
/docs/admin
Which file owns which setting, the environment variables, the ports, where state lives, what to back up, and where the logs are.
Also written for this site
Chapters authored here rather than in the manual tree. They cover subjects the manual does not carry yet; which of the two should own each is an open question.
Getting started
From a built checkout to one channel audible in the main mix — start the console, patch an input, hear it.
Recording and the virtual soundcheck
Arming channels, what a take captures, the take library, and running a soundcheck: load, engage, play, eject.
Undo and the history
One journal for the whole desk, undo and redo, taking back one change out of the middle, and what the journal deliberately never holds.
Channel templates
Saving a channel’s processing for reuse, the factory instrument templates that state only the chain, and the preview of what an apply would move.
Plugins and the insert rack
Racking a plugin on a channel or a bus output, the picker, the generated editor, mono against stereo, and the latency budget the destination sets.
The REAC segment role
Which end of a REAC wire the console presents as — mixer, recorder or automatic — what automatic decides from, and the sentences it gives when it will not take a role.
FAQ
Questions with straight answers.
Including the ones where the answer is no. What it is · Running it · Building on it · Recording and the virtual soundcheck · When the desk refuses · Whether to trust it. The manual keeps a second, shorter FAQ of its own for the arithmetic questions; this one is about the product.
Read the FAQStill being written
What the documentation set does not cover yet.
A written manual is a claim like any other, so this page names the gaps rather than leaving you to find them.
- Control surfaces. There is no operator chapter for the X-Touch yet, because nothing has been driven on real hardware to write one from.
- A deployment guide beyond a single machine. One console on one box is documented. Anything larger is not.
- Screenshots. The manual explains the controls in words; pictures of the surface it names are being captured.
- The manual's own arithmetic FAQ. The product FAQ above is written; the manual's shorter one for the arithmetic questions (mono fold, how many dB twice as loud is) is not a chapter yet.
Development notes, design records and working material are not part of the published set and are not linked here. What publishes is documentation written to be read, or generated straight from the same contract the console itself answers on.