Skip to content

Commit e563112

Browse files
committed
docs(tools): show safety-tier icons on scope index grid cards
Swap each `grid-item-card` header on the six scope index pages (server, session, window, pane, buffer, hook) from a plain tool name + `:link:`/`:link-type:` to an inline `{tooliconl}` role. The role resolves to the tool's detail page and prefixes the linked name with the existing emoji safety badge — 🔍 readonly, ✏️ mutating, 💣 destructive — so readers can see each tool's risk posture at a glance while scanning a scope grid. Dropping `:link:` avoids nested `<a>` (`{tooliconl}` already produces one); click target shifts from whole-card to the title link.
1 parent abcd184 commit e563112

6 files changed

Lines changed: 47 additions & 141 deletions

File tree

docs/tools/buffer/index.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,19 @@ There is **no** `list_buffers` tool. The user's OS clipboard often syncs into tm
77
::::{grid} 1 2 2 3
88
:gutter: 2 2 3 3
99

10-
:::{grid-item-card} load_buffer
11-
:link: load-buffer
12-
:link-type: ref
10+
:::{grid-item-card} {tooliconl}`load-buffer`
1311
Stage content into a new tmux paste buffer.
1412
:::
1513

16-
:::{grid-item-card} paste_buffer
17-
:link: paste-buffer
18-
:link-type: ref
14+
:::{grid-item-card} {tooliconl}`paste-buffer`
1915
Push a staged buffer into a pane.
2016
:::
2117

22-
:::{grid-item-card} show_buffer
23-
:link: show-buffer
24-
:link-type: ref
18+
:::{grid-item-card} {tooliconl}`show-buffer`
2519
Read a staged buffer's contents back.
2620
:::
2721

28-
:::{grid-item-card} delete_buffer
29-
:link: delete-buffer
30-
:link-type: ref
22+
:::{grid-item-card} {tooliconl}`delete-buffer`
3123
Free the server-side state of a staged buffer.
3224
:::
3325

docs/tools/hook/index.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,11 @@ Until one of those paths is implemented, the surface here is visibility only.
1313
::::{grid} 1 2 2 3
1414
:gutter: 2 2 3 3
1515

16-
:::{grid-item-card} show_hooks
17-
:link: show-hooks
18-
:link-type: ref
16+
:::{grid-item-card} {tooliconl}`show-hooks`
1917
Enumerate bindings at a scope.
2018
:::
2119

22-
:::{grid-item-card} show_hook
23-
:link: show-hook
24-
:link-type: ref
20+
:::{grid-item-card} {tooliconl}`show-hook`
2521
Inspect a single binding.
2622
:::
2723

docs/tools/pane/index.md

Lines changed: 20 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5,123 +5,83 @@ Pane-scoped tools — read and drive individual terminals, wait for output, copy
55
::::{grid} 1 2 2 3
66
:gutter: 2 2 3 3
77

8-
:::{grid-item-card} capture_pane
9-
:link: capture-pane
10-
:link-type: ref
8+
:::{grid-item-card} {tooliconl}`capture-pane`
119
Read visible or scrollback text from a pane.
1210
:::
1311

14-
:::{grid-item-card} search_panes
15-
:link: search-panes
16-
:link-type: ref
12+
:::{grid-item-card} {tooliconl}`search-panes`
1713
Search text across many panes in one call.
1814
:::
1915

20-
:::{grid-item-card} snapshot_pane
21-
:link: snapshot-pane
22-
:link-type: ref
16+
:::{grid-item-card} {tooliconl}`snapshot-pane`
2317
Capture content plus cursor, mode, and scroll state in one call.
2418
:::
2519

26-
:::{grid-item-card} get_pane_info
27-
:link: get-pane-info
28-
:link-type: ref
20+
:::{grid-item-card} {tooliconl}`get-pane-info`
2921
Read pane metadata without content.
3022
:::
3123

32-
:::{grid-item-card} display_message
33-
:link: display-message
34-
:link-type: ref
24+
:::{grid-item-card} {tooliconl}`display-message`
3525
Evaluate a tmux format string against a target.
3626
:::
3727

38-
:::{grid-item-card} send_keys
39-
:link: send-keys
40-
:link-type: ref
28+
:::{grid-item-card} {tooliconl}`send-keys`
4129
Send keystrokes or commands to a pane.
4230
:::
4331

44-
:::{grid-item-card} paste_text
45-
:link: paste-text
46-
:link-type: ref
32+
:::{grid-item-card} {tooliconl}`paste-text`
4733
Paste multi-line text via tmux buffer.
4834
:::
4935

50-
:::{grid-item-card} pipe_pane
51-
:link: pipe-pane
52-
:link-type: ref
36+
:::{grid-item-card} {tooliconl}`pipe-pane`
5337
Fork pane output to a file or program.
5438
:::
5539

56-
:::{grid-item-card} select_pane
57-
:link: select-pane
58-
:link-type: ref
40+
:::{grid-item-card} {tooliconl}`select-pane`
5941
Switch focus to a pane.
6042
:::
6143

62-
:::{grid-item-card} swap_pane
63-
:link: swap-pane
64-
:link-type: ref
44+
:::{grid-item-card} {tooliconl}`swap-pane`
6545
Swap two panes' positions.
6646
:::
6747

68-
:::{grid-item-card} set_pane_title
69-
:link: set-pane-title
70-
:link-type: ref
48+
:::{grid-item-card} {tooliconl}`set-pane-title`
7149
Set a pane's human-readable title.
7250
:::
7351

74-
:::{grid-item-card} clear_pane
75-
:link: clear-pane
76-
:link-type: ref
52+
:::{grid-item-card} {tooliconl}`clear-pane`
7753
Clear a pane's scrollback.
7854
:::
7955

80-
:::{grid-item-card} resize_pane
81-
:link: resize-pane
82-
:link-type: ref
56+
:::{grid-item-card} {tooliconl}`resize-pane`
8357
Resize a pane.
8458
:::
8559

86-
:::{grid-item-card} enter_copy_mode
87-
:link: enter-copy-mode
88-
:link-type: ref
60+
:::{grid-item-card} {tooliconl}`enter-copy-mode`
8961
Enter tmux copy mode for scrollback navigation.
9062
:::
9163

92-
:::{grid-item-card} exit_copy_mode
93-
:link: exit-copy-mode
94-
:link-type: ref
64+
:::{grid-item-card} {tooliconl}`exit-copy-mode`
9565
Exit copy mode.
9666
:::
9767

98-
:::{grid-item-card} wait_for_text
99-
:link: wait-for-text
100-
:link-type: ref
68+
:::{grid-item-card} {tooliconl}`wait-for-text`
10169
Block until a pattern appears in a pane.
10270
:::
10371

104-
:::{grid-item-card} wait_for_content_change
105-
:link: wait-for-content-change
106-
:link-type: ref
72+
:::{grid-item-card} {tooliconl}`wait-for-content-change`
10773
Block until pane content changes.
10874
:::
10975

110-
:::{grid-item-card} wait_for_channel
111-
:link: wait-for-channel
112-
:link-type: ref
76+
:::{grid-item-card} {tooliconl}`wait-for-channel`
11377
Block until a tmux wait-for channel is signalled.
11478
:::
11579

116-
:::{grid-item-card} signal_channel
117-
:link: signal-channel
118-
:link-type: ref
80+
:::{grid-item-card} {tooliconl}`signal-channel`
11981
Signal a waiting channel.
12082
:::
12183

122-
:::{grid-item-card} kill_pane
123-
:link: kill-pane
124-
:link-type: ref
84+
:::{grid-item-card} {tooliconl}`kill-pane`
12585
Terminate a pane. Destructive.
12686
:::
12787

docs/tools/server/index.md

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,57 +5,39 @@ Server & process-level tools — discover sessions, control the tmux daemon, rea
55
::::{grid} 1 2 2 3
66
:gutter: 2 2 3 3
77

8-
:::{grid-item-card} list_sessions
9-
:link: list-sessions
10-
:link-type: ref
8+
:::{grid-item-card} {tooliconl}`list-sessions`
119
List all sessions on the tmux server.
1210
:::
1311

14-
:::{grid-item-card} list_servers
15-
:link: list-servers
16-
:link-type: ref
12+
:::{grid-item-card} {tooliconl}`list-servers`
1713
Discover tmux daemons on the system.
1814
:::
1915

20-
:::{grid-item-card} get_server_info
21-
:link: get-server-info
22-
:link-type: ref
16+
:::{grid-item-card} {tooliconl}`get-server-info`
2317
Query server process identity and version.
2418
:::
2519

26-
:::{grid-item-card} create_session
27-
:link: create-session
28-
:link-type: ref
20+
:::{grid-item-card} {tooliconl}`create-session`
2921
Create a new tmux session.
3022
:::
3123

32-
:::{grid-item-card} kill_server
33-
:link: kill-server
34-
:link-type: ref
24+
:::{grid-item-card} {tooliconl}`kill-server`
3525
Terminate the tmux daemon. Destructive.
3626
:::
3727

38-
:::{grid-item-card} show_option
39-
:link: show-option
40-
:link-type: ref
28+
:::{grid-item-card} {tooliconl}`show-option`
4129
Read a tmux option (server / session / window / pane scope).
4230
:::
4331

44-
:::{grid-item-card} set_option
45-
:link: set-option
46-
:link-type: ref
32+
:::{grid-item-card} {tooliconl}`set-option`
4733
Set a tmux option.
4834
:::
4935

50-
:::{grid-item-card} show_environment
51-
:link: show-environment
52-
:link-type: ref
36+
:::{grid-item-card} {tooliconl}`show-environment`
5337
Read the server's environment variables.
5438
:::
5539

56-
:::{grid-item-card} set_environment
57-
:link: set-environment
58-
:link-type: ref
40+
:::{grid-item-card} {tooliconl}`set-environment`
5941
Set an environment variable on the server.
6042
:::
6143

docs/tools/session/index.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,23 @@ Session-scoped tools — enumerate windows, rename or kill a session, switch win
55
::::{grid} 1 2 2 3
66
:gutter: 2 2 3 3
77

8-
:::{grid-item-card} list_windows
9-
:link: list-windows
10-
:link-type: ref
8+
:::{grid-item-card} {tooliconl}`list-windows`
119
Enumerate windows inside a session.
1210
:::
1311

14-
:::{grid-item-card} select_window
15-
:link: select-window
16-
:link-type: ref
12+
:::{grid-item-card} {tooliconl}`select-window`
1713
Switch to a window by id, index, or direction.
1814
:::
1915

20-
:::{grid-item-card} create_window
21-
:link: create-window
22-
:link-type: ref
16+
:::{grid-item-card} {tooliconl}`create-window`
2317
Create a new window inside a session.
2418
:::
2519

26-
:::{grid-item-card} rename_session
27-
:link: rename-session
28-
:link-type: ref
20+
:::{grid-item-card} {tooliconl}`rename-session`
2921
Rename an existing session.
3022
:::
3123

32-
:::{grid-item-card} kill_session
33-
:link: kill-session
34-
:link-type: ref
24+
:::{grid-item-card} {tooliconl}`kill-session`
3525
Terminate a session. Destructive.
3626
:::
3727

docs/tools/window/index.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,31 @@ Window-scoped tools — enumerate panes, split / rename / relayout / resize / mo
55
::::{grid} 1 2 2 3
66
:gutter: 2 2 3 3
77

8-
:::{grid-item-card} list_panes
9-
:link: list-panes
10-
:link-type: ref
8+
:::{grid-item-card} {tooliconl}`list-panes`
119
Enumerate panes inside a window.
1210
:::
1311

14-
:::{grid-item-card} split_window
15-
:link: split-window
16-
:link-type: ref
12+
:::{grid-item-card} {tooliconl}`split-window`
1713
Split a window into a new pane.
1814
:::
1915

20-
:::{grid-item-card} rename_window
21-
:link: rename-window
22-
:link-type: ref
16+
:::{grid-item-card} {tooliconl}`rename-window`
2317
Rename an existing window.
2418
:::
2519

26-
:::{grid-item-card} select_layout
27-
:link: select-layout
28-
:link-type: ref
20+
:::{grid-item-card} {tooliconl}`select-layout`
2921
Apply one of tmux's named layouts.
3022
:::
3123

32-
:::{grid-item-card} resize_window
33-
:link: resize-window
34-
:link-type: ref
24+
:::{grid-item-card} {tooliconl}`resize-window`
3525
Resize a window (client view).
3626
:::
3727

38-
:::{grid-item-card} move_window
39-
:link: move-window
40-
:link-type: ref
28+
:::{grid-item-card} {tooliconl}`move-window`
4129
Reorder a window or move it across sessions.
4230
:::
4331

44-
:::{grid-item-card} kill_window
45-
:link: kill-window
46-
:link-type: ref
32+
:::{grid-item-card} {tooliconl}`kill-window`
4733
Terminate a window. Destructive.
4834
:::
4935

0 commit comments

Comments
 (0)