hex/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Dax b361f49dbf
x86_64: opt-in Ivy Bridge source build (HEX_X86_BASELINE=ivybridge) (#2419)
* x86_64: opt-in Ivy Bridge source build (HEX_X86_BASELINE=ivybridge)

* x86_64 ivybridge build: review fixes
2026-11-22 14:36:17 -05:00
..
features x86_64: opt-in Ivy Bridge source build (HEX_X86_BASELINE=ivybridge) (#2419) 2026-11-22 14:36:17 -05:00
images docs: describe speech models and features in readme (#1869) 2026-11-15 18:27:36 -05:00
plans reload personal config when imported .js files change (#1856) 2026-11-15 10:46:47 -05:00
releases docs(release): correct the 3.4.0 notes and add upgrade steps for Windows and Hyprland (t1510) (#1672) 2026-11-10 18:14:30 -08:00
research Add agent marker and drop internal references (#702) 2026-10-31 18:30:32 -07:00
specs add fluid speech pro to the speech model catalog (#2007) 2026-11-19 15:19:06 -05:00
cli.md labs: hud height for the bottom dictation hud (macos) (#2418) 2026-11-22 14:31:32 -05:00
design-system.md fix(hud): keep the dictation and meeting overlays dark (#1834) 2026-11-16 00:22:48 -08:00
downloads.md ci: read release secrets from aws secrets manager (#1606) 2026-11-09 15:18:26 -05:00
linux.md x86_64: opt-in Ivy Bridge source build (HEX_X86_BASELINE=ivybridge) (#2419) 2026-11-22 14:36:17 -05:00
nix.md docs: nix install is linux only (#1582) 2026-11-09 05:11:35 -05:00
opencode-compatibility.md prefer a wsl opencode service when the lab is on (#2112) 2026-11-20 19:14:28 -05:00
perf.md docs(perf): strobe prints times in microseconds (#1718) 2026-11-12 05:43:43 -06:00
README.md docs: nix install is linux only (#1582) 2026-11-09 05:11:35 -05:00
releasing.md windows: sign the setup engine so smart app control can run setup (#1987) 2026-11-19 02:38:03 -05:00
streams.md feat(meetings): graduate meeting labs into normal behaviour and Meetings settings (#1821) 2026-11-16 00:51:48 -08:00
test-builds.md windows: sign the setup engine so smart app control can run setup (#1987) 2026-11-19 02:38:03 -05:00
transcript-cli.md meetings: delete a finished meeting from the CLI (#2223) (#2225) 2026-11-21 11:23:51 -08:00
windows-signing.md windows: sign the setup engine so smart app control can run setup (#1987) 2026-11-19 02:38:03 -05:00
windows.md x86_64: opt-in Ivy Bridge source build (HEX_X86_BASELINE=ivybridge) (#2419) 2026-11-22 14:36:17 -05:00

Project Documentation

Start with the document for your task. Plans and archived prototypes do not override shipped behavior.

User Guides

  • ../README.md: install and use Hex on macOS, Windows, and Linux.
  • windows.md: Windows x64 and ARM64 beta requirements, installation, and source builds.
  • linux.md: Linux X11 and native Wayland beta requirements and installation.
  • nix.md: Nix packaging for Linux, development, and per-user autostart.
  • ../ios/README.md: build and test the iOS prototype.
  • ../sdk/typescript/README.md: use the public TypeScript transcription SDK with an explicitly supplied native helper.

Engineering Reference

  • ../AGENTS.md: architecture, invariants, development commands, and diagnostics. This is the implementation authority.
  • ../ROADMAP.md: prioritized product and engineering work.
  • design-system.md: Rune + rune-kit + OpenCode theme components, Hex pieces, copy rules, and --snap scene verification.
  • features/README.md: existing user-facing capabilities, entry points, available verification, and gaps; detailed dictation and recovery maps.
  • perf.md: strobe benchmarks, the cases that drive the window through its accessibility tree, and how a benchmarked copy of Hex stays isolated.
  • downloads.md: public download paths, R2 custom domains, GitHub release mirrors, and network recovery.
  • opencode-compatibility.md: audited OpenCode V2 source and CLI baseline, integration contract, and validation limits.
  • plans/personal-commands.md: shipped personal command contract and remaining lifecycle work.
  • plans/quickjs.md: why and how configs run in embedded QuickJS instead of Bun, with size and latency measurements.
  • specs/local-transcription-service.md: implemented macOS local-service protocol and lifecycle guarantees.

Architecture Decisions And Active Plans

When a plan disagrees with AGENTS.md about shipped behavior, update the plan.

Research And Archives

Releases

releases/ contains version-specific release notes and drafts. ../release-notes/ contains legacy inputs from versions 2.0.0 through 2.0.9. Published notes and the SDK changelog describe their release, not current behavior; preserve them as historical records. A draft note is not evidence that its release has been published.