fader_master/docs
Dandaedre 8add95df3f
Rust CI fader_master passed its selected CI mode.
MadGobblins/fader_master/pipeline/head This commit looks good Details
docs: refresh all guides and regenerate mixer screenshots
Bring README, architecture, backlog, checklist, steward baseline, and every docs guide up to date. Document unnamed spacers, current setup/save/restart behavior, MIDI feedback and portable builds. Replace both screenshots with current representative layouts and fixed cell-grid SVG text/border rendering.

Validation PASS: local file links across all 12 Markdown documents; both SVGs parsed and visually inspected after rsvg-convert; repeated doc_screenshots generation produced identical SHA-256 hashes; git diff --check; cargo fmt --all -- --check; cargo check --workspace --all-targets --all-features; cargo clippy --workspace --all-targets --all-features -- -D warnings; canonical architecture-profile schema test; portable no-default-feature package check. Full workspace gates passed in preceding empty-separator implementation commit.
2026-10-16 19:38:59 +02:00
..
images docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
README.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
build.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
ci-coverage.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
configuration.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
midi-identity.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
pulse-daemon-fixture.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00
related-projects.md docs: refresh all guides and regenerate mixer screenshots 2026-10-16 19:38:59 +02:00

README.md

Documentation

Use and configuration

For everyday layout editing: select a fader or separator and press E. Separators accept empty names, independent size and decoration, and Fill space. Config contains theme/orientation/pickup display, hidden-fader restoration, profile switching, MIDI devices, and Save. See the mixer presentation reference.

Design and development

Ecosystem

Screenshot maintenance

Both README screenshots are deterministic renders of the real TUI using example state, not captures of a live audio session:

  • Horizontal mixer: five side-by-side faders, a double divider, an unnamed Fill spacer, mute and group-mixed state.
  • Vertical mixer: section labels, Standard, Slim and Bordered slim rows, and the default output.

Regenerate all screenshots after presentation changes:

cargo run --locked -p tui --example doc_screenshots

The generator lives in doc_screenshots.rs. It places text on the terminal cell grid and draws box/block glyphs to cell edges so font differences do not break borders or meters. Inspect both SVGs in a browser or rasterize with rsvg-convert for review; confirm every fader, label and keyboard hint is visible. Do not hand-edit the generated SVG files.