From 9b947777a2f693d10da1101c3eab4af3a5ef5a10 Mon Sep 17 00:00:00 2001 From: Gabriel Schneider Date: Thu, 1 Oct 2026 15:40:23 -0300 Subject: The guide answers a first session: n walks a build's errors from its command pane, a finished one is already normal, why make wants the project root, opening beside, a builtin's argument by mouse, 12G, and SPC ? is Help everywhere; the tutor's tagline and button names match the site, and the cheatsheet's tree gains data, look and exec Co-Authored-By: Claude Opus 5.5 --- docs/typ/guide.typ | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) (limited to 'docs/typ/guide.typ') diff --git a/docs/typ/guide.typ b/docs/typ/guide.typ index f92709e3..9b881050 100644 --- a/docs/typ/guide.typ +++ b/docs/typ/guide.typ @@ -81,6 +81,9 @@ line 12, column 5. A click takes the word under it: letters, digits and swept. In normal mode #key("Enter") is #word("Look") and #key("Tab") is #word("Exec"). +A builtin's argument: sweep `Find conf` with #btn("B2"), or select `conf`, +then #chord("B2", "B1") on `Find`. + #key("x") #key("y") then #key("p") copies a line below. Every pane shares the registers. #key("SPC y") and #key("SPC p") use the system clipboard. @@ -106,6 +109,8 @@ in a pane's tag quits too. #btn("B2") on `make` runs it with the #word("Shell") setting's `-c`. Where it runs depends on where you clicked: +// TODO(clip: where-commands-run) + #pairs( [a terminal's text or tag, at a prompt with nothing typed], [typed into that shell, in its current directory], [any other pane's text or tag], [a command pane in that pane's directory, in the last column], @@ -113,13 +118,16 @@ Where it runs depends on where you clicked: [the workspace tag], [a command pane in the session's directory, in the last column], ) -So run `make` from a column or the workspace tag, not a file's. The -keyboard stays where it was. The command pane's tag ends in `running`, -then `exit N`: +A file's text and tag run in its directory: `make` from `README` at the +project root is right, from `src/main.c` it is not. The keyboard stays +where it was. The command pane's tag ends in `running`, then `exit N`: #tag("Kill Save Collapse Del", path: "/home/me/src (make) exit 0") -The next command for that directory reuses a finished command pane. +Click into the command pane: #key("n") selects the next `file:line`, +#key("Enter") opens it, and #key("n") from there goes on to the next error. +A finished command pane is in normal mode, so #key("x") #key("y") copy from +it at once. The next command for that directory reuses it. #word("Kill") `make` stops the commands pardes started with `make`. #word("Save") or #word("Del") in a column tag acts on that column's pane with the keyboard, else its first. @@ -132,6 +140,10 @@ on a file open in another column jumps there, but the next new pane still lands in the old column. #word("Placement") `pardes` picks other rules (#doc("reference", section: "placement")). +To open beside: #word("Newcol"), then #word("Look") a file name typed in +its tag opens it there; #key("Alt-c") moves a pane into a new column. +// TODO(clip: columns) + Closing a column's last pane leaves it empty; #word("Delcol") and #word("Joincol") take columns away. Closing the session's last pane quits pardes. @@ -156,6 +168,7 @@ recent first. [#word("Find") `conf`], [a `+Search` of the files below the pane's directory with `conf` in their names], [#word("Grep") `TODO`], [a `+Search` of the lines holding `TODO`, literally, under every pane's directory], ) +// TODO(clip: search) = Unsaved panes @@ -216,7 +229,8 @@ refusals and `--nested` are in the reference. [#key("s")], [a cursor per regex match; every edit acts at each], [#key("/"), #keys("n", "N")], [substring search; step through everything #word("Look") would open, across panes], [#key("g l")], [line end], - [#key("SPC ?")], [every leader path; #word("Help") every key and builtin; #word("Tutor") (#key("SPC h t")) practises them], + [`12G`], [line 12; a bare #key("G") does nothing], + [#key("SPC ?")], [#word("Help"): every builtin, with its leader path and keys; `SPC w ?` only the paths under `SPC w`; #word("Tutor") (#key("SPC h t")) practises them], [#keys("g d", "g r"), `SPC l`], [the language keys, once a server is installed (#doc("setup", section: "language-servers"))], ) -- cgit v1.3