Skip to content

Commit 0e681db

Browse files
committed
docs(quickstart): Add "How it works" section with tool sequence
why: Quickstart showed natural-language prompts but never explained the tool sequence agents execute. The send → wait → capture pattern is the fundamental workflow and should be taught on the first page. what: - Add "How it works" section between "Try it" and "Next steps" - Shows the 3-step pattern: send_keys → wait_for_text → capture_pane - Links to individual tool docs via {ref}
1 parent 88e80da commit 0e681db

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/quickstart.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ Here are a few things to try:
3030
3131
> Search all my panes for the word "error".
3232
33+
## How it works
34+
35+
When you say "run `make test` and show me the output", the agent executes a three-step pattern:
36+
37+
1. {ref}`send-keys` — send the command to a tmux pane
38+
2. {ref}`wait-for-text` — wait for the shell prompt to return (command finished)
39+
3. {ref}`capture-pane` — read the terminal output
40+
41+
This **send → wait → capture** sequence is the fundamental workflow. Most agent interactions with tmux follow this pattern or a variation of it.
42+
3343
## Next steps
3444

3545
- {ref}`concepts` — Understand the tmux hierarchy and how tools target panes

0 commit comments

Comments
 (0)