[Docs] Update reference_info_json.md #18817
Merged
Conversation
This file contains 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
- Makes it easier to find keyboard.jsonschema. - Adds a reference to the Data Driven page.
drashna
approved these changes
Oct 25, 2022
fauxpark
requested changes
Oct 25, 2022
Co-authored-by: Ryan <fauxpark@gmail.com>
zvecr
approved these changes
Nov 28, 2022
ramonimbao
pushed a commit
to ramonimbao/qmk_firmware
that referenced
this pull request
Nov 28, 2022
* [Docs] Update reference_info_json.md - Makes it easier to find keyboard.jsonschema. - Adds a reference to the Data Driven page. * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
elpekenin
pushed a commit
to elpekenin/qmk_firmware
that referenced
this pull request
Dec 7, 2022
* [Docs] Update reference_info_json.md - Makes it easier to find keyboard.jsonschema. - Adds a reference to the Data Driven page. * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
crembz
pushed a commit
to crembz/qmk_firmware
that referenced
this pull request
Dec 18, 2022
* [Docs] Update reference_info_json.md - Makes it easier to find keyboard.jsonschema. - Adds a reference to the Data Driven page. * Update docs/reference_info_json.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
ohlin
added a commit
to ohlin/qmk_firmware
that referenced
this pull request
May 25, 2023
… ko-kyria * 'ko-kyria' of https://github.com/ohlin/qmk_firmware: (603 commits) Fix Czech sendstring LUT (qmk#19193) fix typo (qmk#19189) new keyboard rb1 (qmk#18164) Fix RWIN typo within keycode list (qmk#19155) [Docs] Update reference_info_json.md (qmk#18817) Add piantor (qmk#18920) 2022 Nov 26 changelog. (qmk#19164) Fix API errors in handwired/tractyl_manuform/5x6_right/arduinomicro (qmk#19166) Revert lib/usbhost changes (qmk#19165) Fix encoder_init call order in keyboard_init (qmk#19140) Change `RGB_MATRIX_STARTUP_*` defines to `RGB_MATRIX_DEFAULT_*` (qmk#19079) Fixup installation procedure for different Fedora versions. (qmk#19159) Joystick feature improvements (qmk#19052) Change `LED_MATRIX_STARTUP_*` defines to `LED_MATRIX_DEFAULT_*` (qmk#19080) Fix build failures for `bastardkb/tbk` and `jels/boaty` (qmk#19152) Fix annepro2/c18:iso_default (qmk#19147) jsonify some info.json (qmk#19146) Fixup aurora/corne on develop (qmk#19144) Additional DD backlight config (qmk#19124) [Keymap] komidore64 planck rev6 (qmk#19036) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Make it clear that info.json has a schema file and link to it. This will make it easier for users to find the reason for errors about something not being valid under any of the given schemas.
A second mention of the schema file was added, wrapped with the marker
>?at the end of the first set of options. This is intentional because we all know that we sometimes (but very rarely, of course) jump the intro and go directly to the examples.Finally there was a phrase used as a marker that said: "There are many more optional keys, some of which are described below. Others may be found by examining
data/schemas." Aside from mentioning the schemas folder, I think this was supposed to separate the first six mandatory keys referred in the beginning of the section but it was only separating five keys. Either we're missing a key or the value should be five. So I think it's less confusing to remove the mark. Still, I ask someone who knows the answer to confirm if it's the first five or six keys. Thanks.Types of Changes
Issues Fixed or Closed by This PR
Checklist