Skip to content

Commit e6a5a44

Browse files
committed
docs: Use {tooliconl} for inline paragraph tool refs
Switch {tool} → {tooliconl} in prose paragraphs across tool pages, gotchas, and demo. Keeps {tool} (full badge) in bulleted lists, headers, and tables per the convention in AGENTS.md.
1 parent 924cbdd commit e6a5a44

5 files changed

Lines changed: 20 additions & 20 deletions

File tree

docs/demo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ These are the actual tool headings as they render on tool pages:
6666

6767
### In prose
6868

69-
Use {tool}`search-panes` to find text across all panes. If you know which pane, use {tool}`capture-pane` instead. After running a command with {tool}`send-keys`, always {tool}`wait-for-text` before capturing.
69+
Use {tooliconl}`search-panes` to find text across all panes. If you know which pane, use {tooliconl}`capture-pane` instead. After running a command with {tooliconl}`send-keys`, always {tooliconl}`wait-for-text` before capturing.
7070

7171
### Dense inline (toolref, no badges)
7272

@@ -83,7 +83,7 @@ The fundamental pattern: {toolref}`send-keys` → {toolref}`wait-for-text` → {
8383
## Admonitions
8484

8585
```{tip}
86-
Use {tool}`search-panes` before {tool}`capture-pane` when you don't know which pane has the output you need.
86+
Use {tooliconl}`search-panes` before {tooliconl}`capture-pane` when you don't know which pane has the output you need.
8787
```
8888

8989
```{warning}

docs/tools/panes.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
after running a command, checking output, or verifying state.
1010

1111
**Avoid when** you need to search across multiple panes at once — use
12-
{tool}`search-panes`. If you only need pane metadata (not content), use
13-
{tool}`get-pane-info`.
12+
{tooliconl}`search-panes`. If you only need pane metadata (not content), use
13+
{tooliconl}`get-pane-info`.
1414

1515
**Side effects:** None. Readonly.
1616

@@ -51,7 +51,7 @@ $
5151
**Use when** you need pane dimensions, PID, current working directory, or
5252
other metadata without reading the terminal content.
5353

54-
**Avoid when** you need the actual text — use {tool}`capture-pane`.
54+
**Avoid when** you need the actual text — use {tooliconl}`capture-pane`.
5555

5656
**Side effects:** None. Readonly.
5757

@@ -97,7 +97,7 @@ Response:
9797
which pane has an error, finding a running process, or checking output
9898
without knowing which pane to look in.
9999

100-
**Avoid when** you already know the target pane — use {tool}`capture-pane`
100+
**Avoid when** you already know the target pane — use {tooliconl}`capture-pane`
101101
directly.
102102

103103
**Side effects:** None. Readonly.
@@ -146,7 +146,7 @@ Response:
146146
**Use when** you need to block until specific output appears — waiting for a
147147
server to start, a build to complete, or a prompt to return.
148148

149-
**Avoid when** you can poll with {tool}`capture-pane` instead, or if the
149+
**Avoid when** you can poll with {tooliconl}`capture-pane` instead, or if the
150150
expected text may never appear (set a timeout).
151151

152152
**Side effects:** None. Readonly. Blocks until text appears or timeout.
@@ -190,7 +190,7 @@ Response:
190190
terminal. This is the primary way to execute commands in tmux panes.
191191

192192
**Avoid when** you need to run something and immediately capture the result —
193-
send keys first, then use {tool}`capture-pane` or {tool}`wait-for-text`.
193+
send keys first, then use {tooliconl}`capture-pane` or {tooliconl}`wait-for-text`.
194194

195195
**Side effects:** Sends keystrokes to the pane. If `enter` is true (default),
196196
the command executes.
@@ -339,7 +339,7 @@ Response:
339339
**Use when** you're done with a specific terminal and want to remove it
340340
without affecting sibling panes.
341341

342-
**Avoid when** you want to remove the entire window — use {tool}`kill-window`.
342+
**Avoid when** you want to remove the entire window — use {tooliconl}`kill-window`.
343343

344344
**Side effects:** Destroys the pane. Not reversible.
345345

docs/tools/sessions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
**Use when** you need session names, IDs, or attached status before deciding
99
which session to target.
1010

11-
**Avoid when** you need window or pane details — use {tool}`list-windows` or
12-
{tool}`list-panes` instead.
11+
**Avoid when** you need window or pane details — use {tooliconl}`list-windows` or
12+
{tooliconl}`list-panes` instead.
1313

1414
**Side effects:** None. Readonly.
1515

@@ -47,7 +47,7 @@ Response:
4747
**Use when** you need to verify the tmux server is running, check its PID,
4848
or inspect server-level state before creating sessions.
4949

50-
**Avoid when** you only need session names — use {tool}`list-sessions`.
50+
**Avoid when** you only need session names — use {tooliconl}`list-sessions`.
5151

5252
**Side effects:** None. Readonly.
5353

@@ -84,7 +84,7 @@ Response:
8484
container — create one before creating windows or panes.
8585

8686
**Avoid when** a session with the target name already exists — check with
87-
{tool}`list-sessions` first, or the command will fail.
87+
{tooliconl}`list-sessions` first, or the command will fail.
8888

8989
**Side effects:** Creates a new tmux session. Attaches if `attach` is true.
9090

@@ -158,7 +158,7 @@ Response:
158158
**Use when** you're done with a workspace and want to clean up. Kills all
159159
windows and panes in the session.
160160

161-
**Avoid when** you only want to close one window — use {tool}`kill-window`.
161+
**Avoid when** you only want to close one window — use {tooliconl}`kill-window`.
162162

163163
**Side effects:** Destroys the session and all its contents. Not reversible.
164164

@@ -190,7 +190,7 @@ Session killed: old-workspace
190190
**Use when** you need to tear down the entire tmux server. This kills every
191191
session, window, and pane.
192192

193-
**Avoid when** you only need to remove one session — use {tool}`kill-session`.
193+
**Avoid when** you only need to remove one session — use {tooliconl}`kill-session`.
194194

195195
**Side effects:** Destroys everything. Not reversible.
196196

docs/tools/windows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
**Use when** you need window names, indices, or layout metadata within a
99
session before selecting a window to work with.
1010

11-
**Avoid when** you need pane-level detail — use {tool}`list-panes`.
11+
**Avoid when** you need pane-level detail — use {tooliconl}`list-panes`.
1212

1313
**Side effects:** None. Readonly.
1414

@@ -333,7 +333,7 @@ Response:
333333

334334
**Use when** you're done with a window and all its panes.
335335

336-
**Avoid when** you only want to remove one pane — use {tool}`kill-pane`.
336+
**Avoid when** you only want to remove one pane — use {tooliconl}`kill-pane`.
337337

338338
**Side effects:** Destroys the window and all its panes. Not reversible.
339339

docs/topics/gotchas.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Things that will bite you if you don't know about them in advance. For symptom-b
66

77
## Metadata vs. content
88

9-
{tool}`list-panes` and {tool}`list-windows` search **metadata** — names, IDs, current command. They do not search what is displayed in the terminal.
9+
{tooliconl}`list-panes` and {tooliconl}`list-windows` search **metadata** — names, IDs, current command. They do not search what is displayed in the terminal.
1010

11-
To find text that is visible in terminals, use {tool}`search-panes`. To read what a specific pane shows, use {tool}`capture-pane`.
11+
To find text that is visible in terminals, use {tooliconl}`search-panes`. To read what a specific pane shows, use {tooliconl}`capture-pane`.
1212

1313
This is the most common source of agent confusion. The server instructions already warn about this, but it bears repeating: if a user asks "which pane mentions error", the answer is `search_panes`, not `list_panes`.
1414

@@ -31,7 +31,7 @@ The `enter` parameter defaults to `true`, which is correct for commands (`make t
3131
{"tool": "capture_pane", "arguments": {"pane_id": "%0"}}
3232
```
3333

34-
The capture above may return the terminal state **before** pytest runs. Use {tool}`wait-for-text` between them:
34+
The capture above may return the terminal state **before** pytest runs. Use {tooliconl}`wait-for-text` between them:
3535

3636
```json
3737
{"tool": "send_keys", "arguments": {"keys": "pytest", "pane_id": "%0"}}

0 commit comments

Comments
 (0)