Skip to content

Commit bd19e48

Browse files
committed
docs: update config example coverage
1 parent d66a161 commit bd19e48

3 files changed

Lines changed: 89 additions & 4 deletions

File tree

config.example.toml

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ undo = ["Ctrl+Z"]
3232
# Redo last undone annotation
3333
redo = ["Ctrl+Shift+Z", "Ctrl+Y"]
3434

35+
# Optional undo/redo batch actions
36+
undo_all = []
37+
redo_all = []
38+
undo_all_delayed = []
39+
redo_all_delayed = []
40+
3541
# Duplicate currently selected annotations
3642
duplicate_selection = ["Ctrl+D"]
3743

@@ -111,6 +117,22 @@ return_to_transparent = ["Ctrl+Shift+T"]
111117
# Cycle overlay focus across monitors (layer-shell + xdg fullscreen fallback)
112118
focus_prev_output = ["Ctrl+Alt+Shift+ArrowLeft"]
113119
focus_next_output = ["Ctrl+Alt+Shift+ArrowRight"]
120+
# Board slots and board management
121+
board_1 = ["Ctrl+Shift+1"]
122+
board_2 = ["Ctrl+Shift+2"]
123+
board_3 = ["Ctrl+Shift+3"]
124+
board_4 = ["Ctrl+Shift+4"]
125+
board_5 = ["Ctrl+Shift+5"]
126+
board_6 = ["Ctrl+Shift+6"]
127+
board_7 = ["Ctrl+Shift+7"]
128+
board_8 = ["Ctrl+Shift+8"]
129+
board_9 = ["Ctrl+Shift+9"]
130+
board_prev = ["Ctrl+Shift+ArrowLeft"]
131+
board_next = ["Ctrl+Shift+ArrowRight"]
132+
board_new = ["Ctrl+Shift+N"]
133+
board_duplicate = ["Ctrl+Shift+D"]
134+
board_delete = ["Ctrl+Shift+Delete"]
135+
board_picker = ["Ctrl+Shift+B"]
114136

115137
# Page navigation
116138
# Ubuntu/GNOME defaults avoid Ctrl+Alt workspace shortcuts (Ctrl+ArrowLeft/Right, Ctrl+PageUp/PageDown).
@@ -123,6 +145,9 @@ page_delete = ["Ctrl+Alt+Delete"]
123145
# Toggle help overlay
124146
toggle_help = ["F10", "F1"]
125147

148+
# Toggle quick reference overlay
149+
toggle_quick_help = ["Shift+F1"]
150+
126151
# Toggle status bar
127152
toggle_status_bar = ["F12", "F4"]
128153

@@ -165,6 +190,9 @@ open_context_menu = ["Shift+F10", "Menu"]
165190
# Launch the desktop configurator (requires wayscriber-configurator)
166191
open_configurator = ["F11"]
167192

193+
# Toggle command palette
194+
toggle_command_palette = ["Ctrl+K"]
195+
168196
# Color selection shortcuts
169197
set_color_red = ["R"]
170198
set_color_green = ["G"]
@@ -259,8 +287,8 @@ show_status_board_badge = true
259287
# Show page counter in the status bar
260288
show_status_page_badge = true
261289

262-
# Show the board/page badge even when the status bar is visible
263-
show_page_badge_with_status_bar = false
290+
# Show the floating board/page badge even when the status bar is visible
291+
show_floating_badge_always = false
264292

265293
# Show a "FROZEN" badge when frozen mode is active
266294
show_frozen_badge = false

docs/CONFIG.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,8 @@ show_status_board_badge = true
296296
# Show page counter in the status bar
297297
show_status_page_badge = true
298298

299-
# Show the board/page badge even when the status bar is visible
300-
show_page_badge_with_status_bar = false
299+
# Show the floating board/page badge even when the status bar is visible
300+
show_floating_badge_always = false
301301

302302
# Show a small "FROZEN" badge when frozen mode is active
303303
show_frozen_badge = false
@@ -984,6 +984,12 @@ undo = ["Ctrl+Z"]
984984
# Redo last undone annotation
985985
redo = ["Ctrl+Shift+Z", "Ctrl+Y"]
986986

987+
# Optional undo/redo batch actions
988+
undo_all = []
989+
redo_all = []
990+
undo_all_delayed = []
991+
redo_all_delayed = []
992+
987993
# Duplicate current selection
988994
duplicate_selection = ["Ctrl+D"]
989995

@@ -1073,6 +1079,7 @@ board_9 = ["Ctrl+Shift+9"]
10731079
board_prev = ["Ctrl+Shift+ArrowLeft"]
10741080
board_next = ["Ctrl+Shift+ArrowRight"]
10751081
board_new = ["Ctrl+Shift+N"]
1082+
board_duplicate = ["Ctrl+Shift+D"]
10761083
board_delete = ["Ctrl+Shift+Delete"]
10771084
board_picker = ["Ctrl+Shift+B"]
10781085

@@ -1087,6 +1094,9 @@ page_delete = ["Ctrl+Alt+Delete"]
10871094
# Toggle help overlay
10881095
toggle_help = ["F10", "F1"]
10891096

1097+
# Toggle quick reference overlay
1098+
toggle_quick_help = ["Shift+F1"]
1099+
10901100
# Toggle status bar visibility
10911101
toggle_status_bar = ["F12", "F4"]
10921102

@@ -1127,6 +1137,9 @@ open_context_menu = ["Shift+F10", "Menu"]
11271137
# Launch the desktop configurator (requires wayscriber-configurator)
11281138
open_configurator = ["F11"]
11291139

1140+
# Toggle command palette
1141+
toggle_command_palette = ["Ctrl+K"]
1142+
11301143
# Color selection shortcuts
11311144
set_color_red = ["R"]
11321145
set_color_green = ["G"]

src/config/tests/file_io.rs

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,50 @@ fn create_default_file_writes_example_when_missing() {
5858
});
5959
}
6060

61+
#[test]
62+
fn config_example_parses_and_documents_current_user_facing_fields() {
63+
let example = include_str!("../../../config.example.toml");
64+
toml::from_str::<Config>(example).expect("config.example.toml should parse");
65+
66+
assert!(
67+
example.contains("show_floating_badge_always ="),
68+
"example should use the current floating badge field name"
69+
);
70+
assert!(
71+
!example.contains("show_page_badge_with_status_bar ="),
72+
"example should not use the old floating badge alias"
73+
);
74+
75+
for field in [
76+
"undo_all",
77+
"redo_all",
78+
"undo_all_delayed",
79+
"redo_all_delayed",
80+
"board_1",
81+
"board_2",
82+
"board_3",
83+
"board_4",
84+
"board_5",
85+
"board_6",
86+
"board_7",
87+
"board_8",
88+
"board_9",
89+
"board_prev",
90+
"board_next",
91+
"board_new",
92+
"board_duplicate",
93+
"board_delete",
94+
"board_picker",
95+
"toggle_quick_help",
96+
"toggle_command_palette",
97+
] {
98+
assert!(
99+
example.contains(&format!("{field} =")),
100+
"example should document keybinding field `{field}`"
101+
);
102+
}
103+
}
104+
61105
#[test]
62106
fn create_default_file_errors_when_config_exists() {
63107
with_temp_config_home(|config_root| {

0 commit comments

Comments
 (0)