search

arxanas / scm-record

`scm-record` is a UI component to interactively select changes to include in a commit. It's meant to be embedded in source control tooling.
23 stars 9 forks source link

ux: keyboard shortcuts are undiscoverable #25

Open arxanas opened 6 months ago

arxanas commented 6 months ago

Description of the bug

Many people (like 5 so far?) have reported that they could not find out the keyboard shortcuts, and several resorted to source-diving. For example, see https://github.com/martinvonz/jj/discussions/2951

The keyboard shortcuts are actually discoverable if you use the mouse to click the menu bar items, but 1) it never occurs to many people and 2) using the mouse may not even be an option for many.

Expected behavior

Ideal behavior would probably be a command palette widget. An indefinitely-usable workaround would be to pop up some kind of help page when pressing ?.

Actual behavior

You have to use the mouse or source-dive or simply despair.

Version of rustc

No response

jacobsa commented 6 months ago

+1, I found this issue while looking for documentation on what the keyboard shortcuts are when using from jj. In addition to them being undiscoverable in the editor itself (I never in 100 years would have thought to click in a TUI to use a menu), it would be good if there were some documentation linked from the readme.

emesterhazy commented 2 months ago

I think the discoverability issue may be addressed by https://github.com/arxanas/scm-record/issues/44 since I'm pretty sure all of the shortcuts are visible once the corresponding menu page is expanded.