Developer documentation
End-user documentation lives one level up in doc/; this directory is for
people working on Keyhac itself.
- overview.md — why Keyhac 2 exists; the founding design decisions.
- architecture.md — layers, event loop, threading, the key-event
lifecycle, module map.
- platform-layer.md — what is genuinely OS-specific: hooks,
injection and ordering, focus, clipboard, permissions.
- design-notes.md — per-feature design decisions and the subtle
behaviors deliberately ported from the predecessors.
- puikit.md — what Keyhac uses from PuiKit and the extensions built
for it.
- packaging.md — launchers, bundles, release pipeline, data paths.
- testing.md — test layers, harness patterns, live verification
record.
- next-major.md — ledger of breaking API changes deferred to
the next major release by the additive-only policy, with reasoning.
- ai-integration.md — the AI integration design: agent at
authoring time producing plain-Python actions, the UI-mediated ETL workload
they target, the five layers, the output-side primitives, MCP topologies,
measured platform behaviour, and trace privacy. Open work on it is tracked in
the GitHub issues under the
ai-integration label.
The project guide for coding agents is CLAUDE.md at the repo root.