Skip to content

zmk init UX improvements#57

Merged
joelspadin merged 2 commits intozmkfirmware:mainfrom
joelspadin:init-ux-improvements
Jan 14, 2026
Merged

zmk init UX improvements#57
joelspadin merged 2 commits intozmkfirmware:mainfrom
joelspadin:init-ux-improvements

Conversation

@joelspadin
Copy link
Collaborator

The instructions for the zmk init command sometimes led to confusion because the first thing it asks you for is a repo URL, but new users need to skip past that prompt to get instructions for creating a new repo. To improve this, we now start with a prompt to ask the user whether they want to create a new repo or clone an existing one.

Additionally, opening the page to create a repo from a template in a web browser may fail if the webbrowser module can't identify any installed browsers. If that happens, we now print the link so the user can manually open the page.

The show_menu() function now supports menus without a title by setting
the title parameter to None or some other falsy value like an empty
string.
The instructions for the "zmk init" command sometimes led to confusion
because the first thing it asks you for is a repo URL, but new users
need to skip past that prompt to get instructions for creating a new
repo. To improve this, we now start with a prompt to ask the user
whether they want to create a new repo or clone an existing one.

Additionally, opening the page to create a repo from a template in a
web browser may fail if the webbrowser module can't identify any
installed browsers. If that happens, we now print the link so the user
can manually open the page.
@joelspadin joelspadin added the enhancement New feature or request label Jan 14, 2026
Copy link
Contributor

@caksoylar caksoylar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@joelspadin joelspadin merged commit 7c4e2d2 into zmkfirmware:main Jan 14, 2026
1 check passed
@joelspadin joelspadin deleted the init-ux-improvements branch January 14, 2026 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants