hex/site/README.md
Dax 221a8bcf48
Windows: dictation defaults to Left Alt alone (#2292)
* windows: default the dictation shortcut to the left alt key

Alt sits under the thumb where Option does on a Mac, so holding it to
dictate stops straining the pinky for Ctrl+Space (#2278).

The left Alt only: Windows sends AltGr as a synthesized Left Ctrl plus
the Right Alt, so an either-side Alt would press on every AltGr character,
start a capture, and cancel it when the character joined. A saved
shortcut stays as saved; there is no migration.

The site's hero key and its "Hold …" line follow the selected install tab
(Option, Alt, Alt+Space), and its keycap names that key.

* docs: say the alt chord discards before the hold threshold

* hotkeys: only Linux still builds a Control modifier helper

* tests: pass the windows suite with its new default and CRLF checkout

The playground list test compared the first story to the second through the dictation shortcut, which is now the left Alt on Windows, the same binding the Left Option shortcut story sets; it steps to the third story (Toggle cancel) instead. The bundled skill and the Swift instructions tests normalize CRLF, which a Windows checkout writes into include_str!.

* windows: a modifier outside the shortcut joins as a chord

A modifier-only hold (Left Alt by default) treated Shift, Ctrl, Win, or
the other Alt going down as its release: Hold finished and pasted,
Toggle locked a recording, and Left Alt+Shift injected the 0xE8 mask key
before Alt's release, breaking Windows' input-language switch.

It is a chord like any key now: the press cancels (Labs › Hold through
other keys keeps a hold a second or more old), Toggle locks nothing, and
Alt's release is the app's, so Ctrl+Alt+V still fires Paste Last. A
modifier the chord names is part of it, whichever order the keys go down
in. The modifier-event policy moved to input/modifier_chord.rs, and the
new tests to input/tests/chords.rs, so input.rs stays under its cap.

* site: the show's keycap names the selected OS's shortcut

The animation's shattering keycap was always the Mac's option key. It
takes the same lowercase legend the hero keycap shows now: option with
the glyph, alt, or alt + space.

* tests: import the right shift key the chords hold

* docs: a joined hold leaves alt release to the app

* docs: a swallowed key re-arms alt's release mask

A modifier joining a Left Alt hold leaves Alt's release to the app, but only when Hex swallowed nothing. Paste Last's V is Hex's key, so the mask comes back and the app never reads a lone Alt tap. Say so in windows.md and the feature map, and name the test that holds it.

* site: keep the keycap legend on the dish's bottom row

With the Mac's glyph omitted on Windows and Linux, the label was the dish's only child and space-between put it at the top, while the canvas shatter draws the legend at the bottom. An auto top margin keeps both in the same place; the Mac's glyph and label are unchanged.

* docs: qualify alt's release after a joined hold

Alt's release is the app's after a joining modifier cancels the hold, but not after Hex swallows a key of the chord: Paste Last's V re-arms the mask. Say so in the hook and test comments, and stop claiming every Hold-mode dictation finishes when a tap or chord discards.

* tests: one test at a time drives the windows hook's global state

Paste Last's Ctrl+Alt+V does not leave Alt's release unmasked: its V is
Hex's key, so that chord masks (#1254). Only a hold a joining modifier
cancelled leaves the release to the app. The docs say so now.

Under plain `cargo test` the hook tests share one process, so a static
test lock serializes everything that installs, drives, or clears
CALLBACK_STATE.

---------

Co-authored-by: opencode <opencode@anoma.ly>
2026-11-21 21:38:29 -05:00

118 lines
7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Hex website
`https://anoma.ly/hex` is the one Hex site (dev: `https://dev.anoma.ly/hex`).
`bun run dev` starts Vite. `bun run build [--mode dev]` checks TypeScript and
builds Cloudflare Build Output with base `/hex/`; `bun run check:downloads`
checks that every download link serves a file. `cloudflare.config.ts` defines
both Workers. CI deploys them, never a laptop: Site builds without secrets and
`.github/release/deploy-site.sh` deploys the verified Build Output
(`cf deploy --prebuilt --mode <mode>`), refusing any Worker, route, or binding
other than this config's (docs/releasing.md). `worker.ts` serves the
site and, at `/hex/files/`, the release files: the installers and legacy
appcast built with the site, the dev notes from the Release workflow's
`dev-notes` branch, and the frozen 2.3.1 feeds and artifacts read from
`hex-production-files`. It 301s other hosts and plain HTTP to the canonical
host.
The download section (`src/Download.tsx`) is one install switcher and nothing
else: macOS, Windows, and Linux tabs of equal width with a sliding pill, each
with every way to install there in at most three rows (Mac: DMG, Homebrew;
Windows: installer, PowerShell script; Linux: script, package, binary), a small
switch inside a row where it has variants (x64/ARM64 for the Windows installer
and the Linux binary, which the Linux packages follow too; Debian, Fedora, Nix,
and AUR for the Linux package), and the download button or copyable command.
All three stacks share one grid cell, so switching tabs never moves the page.
An Intel Mac sees that Hex requires Apple silicon instead of a download. It
selects the visitor's OS and architecture on first paint and refines them with
UA client hints. Versions, URLs, and commands live in `src/release.ts`; file
links name `/hex/download/<target>`, which the Worker sends to the stable
release once there is one and to the newest dev build until then. The AUR
package appears from the first build after a stable release, which pushes
`hex-bin`. Add
`?platform=mac|mac-intel|windows-x64|windows-arm64|linux|linux-arm64|mobile`
to see each default. The hero's key and its "Hold …" line follow the selected
tab, so clicking Windows reads Alt and clicking Linux reads Alt+Space; until a
tab is clicked they follow the detected platform.
The hero is a show (`src/shout/`, plain JS): Kit's notifications pile up around a
floating head that answers them out loud, dictates prompts into an OpenCode window
that fixes the complaints, powers up, and finally sprays the inbox clean. WebGPU
renders it, with a Canvas 2D fallback (`?canvas2d` forces it).
- The prerendered page shows `public/shout-idle.webp`, a still of the idle head, in
`.show__head`. The engine chunk loads when the browser is idle or the visitor
reaches for the key (phones wait for the tap), then draws the same head into that box (the canvas reads the
box, 3.2 head radii wide, so nothing moves). The keycap names the selected
OS's shortcut: ⌥ option on the Mac, alt on Windows, and alt + space on Linux.
The key the show shatters keeps that legend too (`start({ key })` reaches
`cards.makeKeycap`, which draws the ⌥ glyph only for option).
- Nothing audible or heavy loads before the key press: the voice bank and its
manifest are fetched on start, the opening clips first. The sound toggle in the
header remembers its choice in `localStorage`.
- It pauses when the tab is hidden or the hero is off screen, runs the idle head at
30 fps on a timer (no frame callback between its frames), caps the pixel ratio
(1.5 on phones), and thins the messages on small screens. The option key's glow
pulses at 30 fps from `src/glow.ts`, set by the key until the engine runs and then
by the engine in the head's frame: as a CSS animation it restyled the page on every
vsync. Reduced motion keeps the still until the key is pressed, then runs only
the calm stage with no shake or flashes.
- Dax, Jay and Frank (teammates) appear with their real X avatars; everyone else is
invented with a generated portrait (`src/shout/assets/people.webp`). Brand glyphs
are Simple Icons (CC0) and Lucide (ISC); OpenCode's mark is from opencode.ai.
`VITE_SHOUT_CAPTURE=1` builds a capture variant with a deterministic frame stepper
(`?capture`, `window.__shout`) and an audio play log; production builds strip it.
Regenerate the idle still after changing the head:
```sh
VITE_SHOUT_CAPTURE=1 bunx vite --port 5531
HEX_SITE_URL=http://127.0.0.1:5531 bun run generate:poster
```
## Performance
`perf/hex.bench.ts` is a [strobe](https://github.com/anomalyco/strobe) bench: load to
the live head, the idle head for 8 s, and the first 20 s of the show after a click
on the key. `strobe.json` builds the site and serves the Build Output under `/hex/`
with `perf/serve.ts`. strobe builds and serves both variants with this checkout's
`strobe.json` and `perf/`, so any commit works as the base. From the repository root:
```sh
strobe bench site/perf/hex.bench.ts --base origin/dev --head .
strobe bench site/perf/hex.bench.ts --head . --check # each case once, pass or fail
strobe report experiment <exp_…> --format pr --update-pr <n> # the results block in PR n
```
In a PR, write your own text (what strobe showed, what changed) and let
`--update-pr` place strobe's generated results block: it replaces only its own
block after a rerun. Don't edit inside it. The bench's `expect` refuses a block
whose page isn't the landing page (`WrongScreen`).
The show draws at its own frame rate, not the display's: `canvas.frames` and
`canvas.interval.p95` count the show's WebGPU frames, where presented frames count
the display's refreshes. `gpu.compile` is the GPU process's shader and pipeline work
during a load.
## Social image
The Open Graph and Twitter image is `public/og.png` (1200 × 630): the app icon,
the name, and one line. `scripts/og/hex-icon.png` is the 1024 px icon exported
from the built app (`iconutil -c iconset Hex.app/Contents/Resources/AppIcon.icns`).
Regenerate with `bun run generate:og`, bump the `?v=` on both image tags in
`index.html`, rebuild, deploy, and fetch the published PNG.
The Labs pages (`/hex/labs`, `/hex/labs/<id>`) each have their own card,
drawn at build by `scripts/labs.ts` with satori and resvg (no browser): the
icon, "Hex Labs", the lab's title and line, and its OSes. Their `?v=` is a
hash of what the card shows. `src/labs.json` comes from the app's Labs
registry; never edit it by hand (`HEX_UPDATE_LABS_JSON=1 scripts/check
labs::web` from the repository root rewrites it).
Messages also plays `public/og.mp4` (`og:video`) inline on a loop in place of the
image; other apps keep the PNG. It's a 4.5 s, 1200 × 630, 60 fps silent H.264
loop: the icon speaks and the words pile up under it
(`scripts/og-video/hex-pour.js`, matter.js physics, deterministic per frame so
the last frame meets the first). `bun run generate:og-video [hex-line|hex-key]`
renders it through Chromium and ffmpeg; bump the `?v=` on both `og:video` tags
after changing it. The Worker answers Range requests for `.mp4`, which Safari
and AVFoundation need.