docs: project foundation (#1) - #5
Merged
Merged
Conversation
Protocol findings from the author's HID++ dumps, decoded hcooper captures, prior-art analyses of logilinux, Julusian's library and logimap, and the web research pass. Raw pcaps stay out of git; hcooper's derived fixtures and license are tracked. Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Decisions from the 2026-09-09 planning grill, post-research architecture, milestones M0-M5 with the bootstrap steps, the M0 measurement list and risks. Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Rename to keyvo and fold in the research findings: two protocol planes, mandatory keep-alive, runtime geometry query, ACK-driven image writes, Dialpad over Bolt, context engine defaults, config layout, socket API, renderer pipeline, GUI and Windows plugin scope, prior-art table and resolved open questions. Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
ADR-0001 Rust core, 0002 two-layer dev model, 0003 no Lua in v1, 0004 GUI edits TOML with round-trip, 0005 no crates.io in v1, 0006 Dialpad via own HID++ subset, 0007 C# Logi Actions plugin, plus the ADR index. Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Project rule: no em-dashes and no emojis in any artifact. Rewritten in context with colons, commas, parentheses or sentence splits; numeric ranges keep the en-dash. Signed-off-by: Biró, Csaba Attila <csaba.biro@qubernetic.com>
Closed
3 tasks
13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Lands every document that defines keyvo before any code: the research-corrected specification v0.2, the project plan, seven architecture decision records, the glossary, the roadmap, the research reports and capture fixtures, and the contributor-facing policy files and templates.
Closes #1
Changes
docs/spec.mdrewritten to v0.2 from the research: two protocol planes, mandatory keep-alive, runtime geometry query, ACK-driven image writes, Dialpad over Bolt, context engine defaults, config layout, socket API, renderer pipeline, resolved open questionsdocs/plans/2026-09-09-project-plan.md,docs/roadmap.md,CONTEXT.mddocs/adr/0001–0007plus indexdocs/research/*reports andcaptures/(raw pcaps excluded; hcooper's derived fixtures and license tracked)CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md,CLAUDE.md.github/: PR template with User test section, issue templates, CODEOWNERS, close-linked-issues workflowAutomated checks
tesserareferences outside historical notesUser test
Ticked by the owner. This PR touches no device behaviour; the test is a read-through.
docs/spec.md§5 (device layer) matches your understanding of the Keypad and Dialpad findingsdocs/spec.md§6 timing defaults and §7 config layout match the grill decisionsCONTEXT.mdterms are the words you want used in code and GUICLAUDE.mdandCONTRIBUTING.mddescribe the workflow you want enforcedNew issue): deferred, GitHub renders templates from the default branch only, so this is checked after the first merge tomainNotes for reviewer
The
close-linked-issuesworkflow was scheduled for B3 in the plan but is a repository file, so it ships here rather than as a second direct commit tomain.