summaryrefslogtreecommitdiff
path: root/docs/typ/guide.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 12:41:52 -0300
committerGabriel Schneider <[email protected]>2026-10-01 12:42:16 -0300
commit406d0bc6f1debe5d9de43a60ab0931d937845194 (patch)
treed75edec7819b06d32583bedcb4275ef782a5d6c0 /docs/typ/guide.typ
parent3c1668e02395d41bb83a4df3d85bf47a7bbdbef4 (diff)
downloadpardes-406d0bc6f1debe5d9de43a60ab0931d937845194.tar.gz
pardes-406d0bc6f1debe5d9de43a60ab0931d937845194.zip
The docs call pardes's scripting interface a virtual filesystem, served over 9P, and the guide opens on look and execute as the core idea
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/guide.typ')
-rw-r--r--docs/typ/guide.typ13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/typ/guide.typ b/docs/typ/guide.typ
index f154bb1b..3a6e5bea 100644
--- a/docs/typ/guide.typ
+++ b/docs/typ/guide.typ
@@ -3,11 +3,14 @@
// keys on the cheatsheet.
#import "style.typ": key, keys, btn, chord, word, tag, addr, file, cmd, doc, pairs, glossary
-pardes is a screen of columns. Each column holds panes, and each pane is a
-tag (a line of words) over a body: a file, a terminal, a PDF or an image.
-Above the columns runs the workspace tag, and each column has a tag of its
-own. Any text anywhere can be clicked: #btn("B2") runs it, #btn("B3") looks
-at it. The keys are helix's, in modes.
+pardes reads the text on its screen as things to do. Right-click (#btn("B3"))
+any text to *look* at it: open the `file:line`, address or URL it names, or
+else find the text. Middle-click (#btn("B2")) it to *execute* it: run the
+builtin it names, or else run it as a shell line. Everything else is where
+that happens: columns of panes, each a tag (a line of words) over a body
+that is a file you edit, a terminal, a PDF or an image, with a tag for each
+column and the workspace above. The keys are helix's, in modes, and every
+session is also a virtual filesystem, served over 9P, for scripts.
#glossary("Words you'll see", <words>,
[tag], [the line of words over a pane, a column or the screen; every word in it can be clicked],