Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[XAP] finalise XAP spec definition format #15601

Open
tzarc opened this issue Dec 27, 2021 · 0 comments
Open

[XAP] finalise XAP spec definition format #15601

tzarc opened this issue Dec 27, 2021 · 0 comments
Assignees

Comments

@tzarc
Copy link
Member

tzarc commented Dec 27, 2021

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.

@tzarc tzarc added enhancement help wanted xap XAP-related issues/PRs labels Dec 27, 2021
@tzarc tzarc changed the title [XAP] route and broadcast documentation [XAP] finalise XAP spec definition format Dec 28, 2021
@tzarc tzarc self-assigned this Mar 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In progress
Development

No branches or pull requests

1 participant