Skip to content

Guide in the rail makes the studio explain itself - #758

Merged
thcp merged 2 commits into
next-releasefrom
feat/help-mode
Oct 4, 2026
Merged

thcp merged 2 commits into
next-releasefrom
feat/help-mode

Conversation

@thcp

@thcp thcp commented Oct 4, 2026

Copy link
Copy Markdown
Collaborator

A new user can now find out what every control does without pressing it.

What changes

  • Guide, a new rail button below Trash, turns help mode on. A small pill at the bottom says so, and how to leave: Esc, or Guide again.
  • Point at any control, focus it with Tab, or click it: a ring goes around what you see of it, and a box beside it shows the control's own label and what it does, in plain words.
  • Clicks explain instead of acting while help mode is on, so exploring never starts an extraction or changes a song. This is also how it works on a touch screen.
  • Coverage: the top bar, the rail, the song list, every lane control (naming its instrument, "Silences Drums"), the song facts, the waveforms and the bottom bar. Settings lists every option, tab by tab, one line each, including opening StemDeck on a phone.
  • The ring is its own layer, sized to the visible icon and label, so nothing in the studio moves and no panel clips it.
  • Texts are help.* keys in all ten languages. The box's title is each control's existing, already translated label.

Keyboard shortcuts (L, K, space) still work in help mode; only presses are taken.

Testing

  • New tests/e2e/help-mode.spec.mjs, 6 tests: on and off with Guide and Esc, the pill, a box under the control's own label, a lane control naming its instrument, a click that explains instead of acting (and acts again once help mode is off), the full Settings list, and every covered control resolving to a real title and text.
  • Full Playwright suite: 459 passed. JS syntax and JS tests clean, i18n clean in all ten languages, uv.lock unchanged.
  • Checked by hand on a local server.

The nine translations are mine and have not been read by a native speaker. pt-PT shows the Brazilian text.

Closes #757

Thales added 2 commits October 4, 2026 17:57
Nothing in the studio said what its controls do, and a new user has to
press things to find out, which can start an extraction or delete a song.

Guide, in the rail below Trash, turns help mode on, and a pill at the
bottom says so. Pointing at a control, focusing it, or clicking it
outlines it and shows a box beside it with the control's own label and
what it does, in plain words. Nothing else is marked, so the screen
stays calm. While help mode is on, presses are taken by it, so
exploring never acts on the studio. Esc or Guide again turns it off.

The box covers the top bar, the rail, the song list, every lane control
(naming its instrument), the song facts, the waveforms and the bottom
bar. Settings lists every option, tab by tab, in one line each. Texts
are help.* keys in all ten languages.

Closes #757
In help mode the box over a lane's M button was headed "M", and S, +
and the K box the same: the heading took the visible text first, and
for these it is one character. Someone who does not know what M means
learned nothing from the heading.

A visible text of one or two characters now gives way to the button's
full label ("Mute Drums", "Transpose Drums up one semitone"). The K box
has no label of its own, so it gets one: "Key of Drums", in all ten
languages.

Refs #757
@thcp
thcp merged commit 72d83c7 into next-release Oct 4, 2026
10 checks passed
@thcp thcp mentioned this pull request Oct 4, 2026
thcp added a commit that referenced this pull request Oct 4, 2026
feat(help): Guide in the rail makes the studio explain itself

Nothing in the studio said what its controls do, and a new user has to
press things to find out, which can start an extraction or delete a song.

Guide, in the rail below Trash, turns help mode on, and a pill at the
bottom says so. Pointing at a control, focusing it, or clicking it
outlines it and shows a box beside it with the control's own label and
what it does, in plain words. Nothing else is marked, so the screen
stays calm. While help mode is on, presses are taken by it, so
exploring never acts on the studio. Esc or Guide again turns it off.

The box covers the top bar, the rail, the song list, every lane control
(naming its instrument), the song facts, the waveforms and the bottom
bar. Settings lists every option, tab by tab, in one line each. Texts
are help.* keys in all ten languages.

Closes #757


fix(help): head a lane's M, S, + and K boxes with what they do

In help mode the box over a lane's M button was headed "M", and S, +
and the K box the same: the heading took the visible text first, and
for these it is one character. Someone who does not know what M means
learned nothing from the heading.

A visible text of one or two characters now gives way to the button's
full label ("Mute Drums", "Transpose Drums up one semitone"). The K box
has no label of its own, so it gets one: "Key of Drums", in all ten
languages.

Refs #757
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant