docs: explain the command palette in the user guide - #88
Merged
Conversation
Covers what is in it, how the fuzzy matching behaves, the keys that move around it, and how to reach it on a phone. Adds Ctrl+K to the keyboard shortcuts page, which had every other chord but not this one.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The command palette shipped in #86 with no user guide page. This adds one, under Getting around, between "Finding a todo" and "Keyboard shortcuts".
Covers what's in the palette (the four groups), how the fuzzy matching actually behaves, the keys that move around it, how to reach it on a phone, and what it deliberately doesn't do.
Also adds
Ctrl+Kto the keyboard shortcuts page. That table listed every other chord but not this one, which was wrong the moment the palette landed — the app's own Help modal has listed it since.On the typo examples
I checked these against
filterCommandsrather than writing them from memory, and the first draft was wrong. Single-typo misspellings match —sumary→ Summary,serch→ Search,setings→ Settings — but heavy vowel-dropping does not:tmrwfinds nothing at the 0.3 threshold, and neither do initialisms likenl. The page now says so, and points at short prefixes instead (tom→ Tomorrow), which do work.Worth knowing if the threshold is ever tuned: these examples are load-bearing and would need re-checking.
Notes
*(added …)*annotations, per CLAUDE.md — that convention is for specs, not the guide.bun run docs:buildpasses, so the dead-link check is happy with the new cross-links.