ianyh/Amethyst

Better Action Descriptions

Open

#1041 opened on Aug 5, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Swift (16,121 stars) (516 forks)batch import
enhancementhelp wanted

Description

I'm always frustrated when I try to add new behavior to my configuration but have no idea if I'm assigning a keybinding to the right command until I try it out. i.e. - I just tried to make it so I can do something similar to cmd + tab, but just for the windows within my current workspace, but either I'm assigning to the wrong command or I'm assigning an invalid key-binding.

It would be great if the commands had descriptions and/or visual representations that you could expand from within the preferences pane.

Contributor guide

Tech stack
swift
Domain
desktopdocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
SwiftmacOS developmentAmethyst codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate how commands are defined and displayed in the preferences pane (e.g., in Command.swift or Preferences window). Look for existing description fields or tooltips. Update the command model to include a description and modify the UI to show it, possibly as a tooltip or expandable section.