8000 hex/docs at dev · BowtiedRahman/hex · GitHub
[go: up one dir, main page]
Skip to content
< 10000 script type="application/json" data-target="react-partial.embeddedData">{"props":{"color_mode":"dark","logged_in":false,"marketing_page":false,"home_path":"/","login_path":"/login?return_to=https%3A%2F%2FgitHub.com%2FBowtiedRahman%2Fhex%2Ftree%2Fdev%2Fdocs","signup_path":"/signup?ref_cta=Sign+up\u0026ref_loc=header+logged+out\u0026ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Ffiles%2Fdisambiguate\u0026source=header-repo\u0026source_repo=BowtiedRahman%2Fhex","signup_enabled":true,"is_signup_controller":false,"show_search_and_nav":true,"hide_search":false,"private_mode_enabled":false,"should_use_dotcom_links":true,"auth_hydro_click":"{\"event_type\":\"authentication.click\",\"payload\":{\"location_in_page\":\"site header menu\",\"repository_id\":null,\"auth_type\":\"SIGN_UP\",\"originating_url\":\"https://gitHub.com/BowtiedRahman/hex/tree/dev/docs\",\"user_id\":null}}","auth_hydro_click_hmac":"1265452327ec83a2aca1703809ff8a988fe72f486938690bb939900bf121828e"}}

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

docs

README.md

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, 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.
  • 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.
0