pardes.git/docs/typ/style.typ, branch release-0.24

Release Pardes 0.24

2026-10-02T05:14:17Z

Co-Authored-By: Claude Opus 5.5

The site's downloads are rebuilt from the round-38 fixes: new sizes and checksums

2026-10-02T01:28:58Z

Co-Authored-By: Claude Opus 5.5

The site's downloads are rebuilt from the acme-gaps line: new sizes and checksums

2026-10-01T23:26:39Z

Co-Authored-By: Claude Opus 5.5

The guide shows the where-commands-run, columns and search clips in place of their TODOs

2026-10-01T18:45:29Z

#clip takes `wide: true` for a recording that needs the page's full width; the columns clip (80 columns split three ways) uses it, the others keep the 640 px inline width. An inline video takes its own shape from its poster rather than a fixed ratio. where-commands-run's caption is trimmed to eleven words. Co-Authored-By: Claude Opus 5.5

The guide's glossary is a definition list, and the site's tutor links its pointers into the guide

2026-10-01T18:42:55Z

On the site the glossary is a

of terms and meanings inside its

, with no stray count, so a text browser reads each term then its meaning. The tutor page links docs/typ/.typ to that page, each "-> Guide:

" to the guide's section of that title (read from guide.typ's headings), and URLs; the tutor itself keeps its text. Co-Authored-By: Claude Opus 5.5

A chapter can show a recording: #clip(name), used once for the chords in the guide's mouse section

2026-10-01T18:25:59Z

#clip reads docs/site/media/clips.toml. On the site it is the landing's video (poster, autoplay muted loop playsinline, controls) with its caption, and the in-view script that plays it now runs on every page; in the book it is the poster at 7 cm with the caption. The guide shows the chords clip under its mouse table, in place of the TODO. Co-Authored-By: Claude Opus 5.5

The landing's words jump to their recordings, the casts open on their telling frame, and #mode-box draws the box

2026-10-01T18:24:04Z

Each recording on the landing has an anchor (rec-); the "What's in it" words jump to theirs (Terminals, PDFs, Images, Diff review, Scripting) and the recording's caption ends in a link to the docs; Language servers and Themes, with no recording, link to the docs. A cast's `poster_at` in casts.toml picks the frame it shows until it plays: live-text at the error, terminals at the copied line, petscii on the Mandelbrot; the casts wait for the in-view script to play them. A caption may hold markup: the 9P clip links 9ns to setup. The downloads give their size, read from project.download, and the footer links the changes (project.changes). The guide's annotated pane has alt text, pin 1 beside the workspace tag rather than on Changelog, and pin 5 on the body's text; pin positions are written with repr, since str puts a U+2212 minus CSS cannot read. #mode-box(mark, unsaved:) draws a pane's box as it looks, in print and HTML. Co-Authored-By: Claude Opus 5.5

Install offers the built pardes 0.23 binaries first, each with its checksum, then building from source

2026-10-01T16:55:09Z

`project.download` in style.typ holds the version, the SHA256SUMS link and a file per program (the static terminal build and the window build, with what each needs); install.typ shows, for each, the curl, the sha256sum -c of its own checksum and the move into ~/.local/bin, then the clone and the build as the alternative. Co-Authored-By: Claude Opus 5.5

The landing shows each thing once, lists what is in pardes, and the guide opens on an annotated pane

2026-10-01T16:47:24Z

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

Builtins are chips that link to a glossary generated from the registry, and the virtual filesystem is drawn as a tree

2026-10-01T16:16:47Z

#word draws a builtin as a chip on the tag's ground over a rule (Look and Exec in acme's look green and exec red), a

 in HTML,
and links it to its entry in a new Builtins chapter wherever that
chapter is in the same output (the book, the site). The chapter is
drawn from docs/typ/builtins-tty.json and builtins-gui.json, which
`zig build builtins-json -Dplatform=tty|gui` writes from the registry
and the Help rows (src/builtins_json.zig, tools/gen_builtins_json.zig;
summaryOf in ninep/ctl.zig is now pub); style.typ merges them, marking
the window-only words. The doc steps refresh their build's file first,
and each build's unit-test fails when its file is stale. Everyday words
first (`everyday` in style.typ), then groups by leader prefix as Help
has them, then settings, the words with no path, debugging and
internals, and last an A-Z index of every word. `zig build book` joins
the doc steps.

#fstree draws a directory tree with its connectors, a description
column and links to the sections that document each file; reference.typ
draws the served tree with it, each pane, pty and column file on its
own line, and a test in config.zig checks it against ninep/tree.zig's
files both ways. The cheatsheet has a two-level version. On the site
the tree reads as `tree` text in w3m and wraps descriptions under the
names on a phone.

The site's tutor draws its B1, B2, B3 and 1-2 chords as mouse glyphs;
the landing credits Plan 9 and acme, as does the book's title page;
install.typ no longer lists the mirrors (the footer does).

Co-Authored-By: Claude Opus 5.5