Skip to content

Commit ee64727

Browse files
committed
docs(README): link core concepts to API docs
why: Users should be able to jump directly to API reference from the core concepts table. what: - Link Server/Session/Window/Pane to their respective API pages - Add note about Options and Hooks abstractions with links
1 parent afe8719 commit ee64727

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,12 @@ Session($... ...)
226226

227227
| libtmux object | tmux concept | Notes |
228228
|----------------|-----------------------------|--------------------------------|
229-
| `Server` | tmux server / socket | Entry point; owns sessions |
230-
| `Session` | tmux session (`$0`, `$1`,...) | Owns windows |
231-
| `Window` | tmux window (`@1`, `@2`,...) | Owns panes |
232-
| `Pane` | tmux pane (`%1`, `%2`,...) | Where commands run |
229+
| [`Server`](https://libtmux.git-pull.com/api/servers.html) | tmux server / socket | Entry point; owns sessions |
230+
| [`Session`](https://libtmux.git-pull.com/api/sessions.html) | tmux session (`$0`, `$1`,...) | Owns windows |
231+
| [`Window`](https://libtmux.git-pull.com/api/windows.html) | tmux window (`@1`, `@2`,...) | Owns panes |
232+
| [`Pane`](https://libtmux.git-pull.com/api/panes.html) | tmux pane (`%1`, `%2`,...) | Where commands run |
233+
234+
Also available: [`Options`](https://libtmux.git-pull.com/api/options.html) and [`Hooks`](https://libtmux.git-pull.com/api/hooks.html) abstractions for tmux configuration.
233235

234236
Collections are live and queryable:
235237

0 commit comments

Comments
 (0)