Add Descriptions to keyboard.jsonschema #24594
Open
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.
Description
My main goal was to add the descriptions from the
docs/reference_info_json.md
to thedata/schemas/keyboard.jsonschema
while doing so I had some issues because the schemas didn't follow standard json syntax and I didn't want to use something like hjson for a machine readable schema. So I adjusted the schemas a bit to follow the standard (removed/added commas, converted comments to$comment
fields)I would also suggest to rename those files to
*.schema.json
and define a default format for them to make it easier to work with across multiple tools. Let me know what you think and I can do that in a seperate PR also adjusting the CLI tools that rely on these files.For easier review I have split the json fixes, formatting, and adding of data in multiple commits
Types of Changes
Issues Fixed or Closed by This PR
Checklist