Skip to content

The Guide has no entry for several new 0.21.0 controls #785

Closed

Description

@thcp

What goes wrong

The project rule is that a feature is not done until the Guide covers it. The Guide (static/js/helpMode.js) has no entry for: the Stems popover; Karaoke's own controls (Queue, Backing vocals switch, Transport panel, fullscreen); the Mode menu rows Practice and Advanced; Performance's Recording & Output card (Video Source, Audio Source, resolution, frame rate, REC, Export MP4, Show in folder, I play, Take Timeline zoom and trim); and Settings, Library and the Video encoder with Test encoders. The sentence help.karaoke still says Karaoke has "Key, Speed and Stems controls" although the speed box was removed.

Who is affected

New users, who rely on the Guide to learn the app.

How to see it

Open the Guide (book icon) and point at each control listed. Nothing is shown.

Evidence

  • static/js/helpMode.js:20-140 (HELP), :147-179 (SETTINGS, no settings.tab.library, export tab lists sampleRate and videoQuality only).
  • static/js/i18n.js help.karaoke (English); the same stale sentence is in the other nine tables.

Constraints for anyone fixing it

  • Every entry needs a selector, a help.* key and the sentence in all ten tables of i18n.js.
  • Write for a person who has never seen the app, one or two short sentences, no internal names.
  • The help-mode Playwright spec covers this and is paused; one run is owed.

Origin

NEW in 0.21.0. Found on the big-release branch (draft pull request #784); the work is not released yet.

Possible direction

Add the entries in one change per area (Karaoke, Performance, Stems, Settings).

Verified by

read.

Activity

  1. added
    bugSomething isn't working
    documentationImprovements or additions to documentation
    on Oct 11, 2026
  2. self-assigned this
    on Oct 11, 2026
  3. added a commit that references this issue on Oct 17, 2026
    30166dd
  4. thcp commented on Oct 18, 2026

    @thcp
    CollaboratorAuthor

    Fixed: the Guide now has entries for the new Karaoke and Performance controls (fullscreen, Queue, Backing vocals, Transport, REC, Video Source, Audio Source, resolution, frame rate, Export MP4, Show in folder, I play, Take Timeline zoom and trim), in all ten languages. On big-release (#809), ships in 0.21.0.

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

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions