summaryrefslogtreecommitdiff
path: root/docs/typ/guide.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 13:43:11 -0300
committerGabriel Schneider <[email protected]>2026-10-01 13:47:24 -0300
commitbbbaf75a6f231475a7b50be7eaadd141d9264215 (patch)
tree6d9db16eba9d64faa48d8761118e1a13fc02ff96 /docs/typ/guide.typ
parentbac1c62c1905a5ce11a6b630d556bc349041628b (diff)
downloadpardes-bbbaf75a6f231475a7b50be7eaadd141d9264215.tar.gz
pardes-bbbaf75a6f231475a7b50be7eaadd141d9264215.zip
The landing shows each thing once, lists what is in pardes, and the guide opens on an annotated pane
The window shelf drops terminals-are-panes (`landing = false` in clips.toml; the casts show it) and keeps the PDF, image, make, diff and 9P clips. Captions say what happens: the live-text cast renames a variable, runs make and lands on the error; the 9P clip is a shell under 9ns where the session is a directory. Casts stack one per row at the page's width, each showing a frame of itself until it plays. Under the lead, a row of linked chips names what is in pardes: terminals, PDFs, images, language servers, diff review, scripting, themes. Install says how long the first build takes (62 s from a clean cache on 16 cores, measured with the dependencies already fetched), and `project` in style.typ has a `download` slot (url, sha256, arch) install.typ shows once a binary exists. #annotated draws a screenshot with numbered pins and their labels as text beside it; the guide opens with one of the orchard theme's shot: the workspace tag, a column's tag, a pane's tag, the box, the body and the scrollbar, before its glossary. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/guide.typ')
-rw-r--r--docs/typ/guide.typ11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/typ/guide.typ b/docs/typ/guide.typ
index e2b9ae77..1505afbc 100644
--- a/docs/typ/guide.typ
+++ b/docs/typ/guide.typ
@@ -1,7 +1,7 @@
// The guide: pardes day to day, the path a newcomer reads once. Edge cases
// live in the reference, the pager and the language servers in setup, the
// keys on the cheatsheet.
-#import "style.typ": key, keys, btn, chord, word, tag, addr, file, cmd, doc, pairs, glossary
+#import "style.typ": key, keys, btn, chord, word, tag, addr, file, cmd, doc, pairs, glossary, annotated
pardes reads the text on its screen as things to do, with two builtins.
#word("Look") (right-click) on `src/bar.c:12` opens that line; on a URL,
@@ -11,6 +11,15 @@ screen is columns of panes, each a tag (a line of words) over a file, a
terminal, a PDF or an image. The keys are helix's, and every session is a
virtual filesystem, served over 9P, for scripts.
+#annotated("/docs/site/media/themes/orchard.png", (640, 513),
+ ([the workspace tag: words for the whole session], 330, 11),
+ ([a column's tag], 400, 34),
+ ([a pane's tag: its path, then its words], 560, 58),
+ ([the box: the pane's mode, and the handle to drag it], 8, 58),
+ ([the body: here a file, below it a terminal], 500, 128),
+ ([the scrollbar: how much of the body is in view], 8, 160),
+)
+
#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],
[the pane with the keyboard], [where your keys go; one pane at a time],