qmk/qmk_firmware

[XAP] finalise XAP spec definition format

Open

#15.601 geöffnet am 27. Dez. 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C (43.867 Forks)batch import
enhancementhelp wantedin progressxap

Repository-Metriken

Stars
 (20.368 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 20T 9h) (27 gemergte PRs in 30 T)

Beschreibung

XAP Task Info

Original Issue Original spec document Current XAP Definitions Current XAP Generated Docs Placeholder PR

Description

Any work in this area needs to be discussed with QMK Collaborators first, and in this case primarily with @tzarc due to their prior work in this area.

XAP protocol definitions under data/xap need to be finalised such that they contain documentation as well as enough information to generate firmware-side code and host app binding code. These are the "single source of truth" for everything related to the XAP protocol. All information required such as mappings or transformations needs to be defined in the XAP definitions, rather than "hacked about" in generator code.

An appropriate *.jsonschema is required.

Contributor Guide