Andrew C a1096e1dec Deprecate LAYOUT() macro in favor of JSON matrix definitions ...

* Indicate <keyboard>.h LAYOUT() deprecation in understanding_qmk.md

Initial documentation uses <keyboard>.json to define matrix pin definitions, rather than having users #define the LAYOUT() macro in <keyboard>.h  -  This change brings this docs inline with the [porting_guidelines](https://docs.qmk.fm/porting_your_keyboard_to_qmk),  QMK MSYS will also throw an error if this is attempted.

* Update understanding_qmk.md

enclosed '<' using backtick

* style guideline, now builds correctly

prior version indicates directory, new indicates config. still the same idea.

2025-11-04 15:06:56 +08:00

..

ChangeLog

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

drivers

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

features

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

public

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

__capabilities_inc.md

…

__capabilities.md

…

_aliases.json

…

_sidebar.json

2025q3 develop changelog (#25597)

2025-09-06 07:07:20 +10:00

api_development_environment.md

…

api_development_overview.md

…

api_docs.md

…

api_overview.md

…

arm_debugging.md

…

breaking_changes_history.md

2025q3 develop changelog (#25597)

2025-09-06 07:07:20 +10:00

breaking_changes_instructions.md

…

breaking_changes.md

2025q3 develop changelog (#25597)

2025-09-06 07:07:20 +10:00

chibios_upgrade_instructions.md

…

cli_commands.md

Print build failures with qmk mass-compile and qmk userspace-compile if requested (-p/--print-failures) (#25518)

2025-09-09 17:35:01 +01:00

cli_configuration.md

…

cli_development.md

Align to latest CLI dependencies (#24553)

2025-03-20 14:04:10 +11:00

cli_tab_complete.md

…

cli.md

Merge remote-tracking branch 'origin/master' into develop

2025-05-07 14:42:14 +00:00

coding_conventions_c.md

…

coding_conventions_python.md

Align to latest CLI dependencies (#24553)

2025-03-20 14:04:10 +11:00

compatible_microcontrollers.md

Added MCU support for ArteryTek AT32F415 (#23445)

2024-11-21 17:28:28 +11:00

config_options.md

Remove DEFAULT_FOLDER handling (#23281)

2025-06-09 05:08:56 +01:00

configurator_architecture.md

…

configurator_default_keymaps.md

Update leftover RGB keycodes (#24653)

2024-11-30 05:30:05 +00:00

configurator_diagram.drawio

Add EOL to non-keyboard files (#24990)

2025-03-06 23:17:51 +00:00

configurator_diagram.svg

Add EOL to non-keyboard files (#24990)

2025-03-06 23:17:51 +00:00

configurator_step_by_step.md

…

configurator_troubleshooting.md

…

contributing.md

qmk docs: restore --port and --browser arguments (#24623)

2025-02-01 21:19:30 +11:00

custom_matrix.md

…

custom_quantum_functions.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

data_driven_config.md

Update data_driven_config.md (#25612)

2025-09-10 01:52:25 -07:00

documentation_best_practices.md

…

documentation_templates.md

…

driver_installation_zadig.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

easy_maker.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

faq_build.md

…

faq_debug.md

[Core] get_keycode_string(): function to format keycodes as strings, for more readable debug logging. (#24787)

2025-03-19 20:45:56 +01:00

faq_general.md

Correct link in faq_general.md (#25640)

2025-09-09 19:43:28 -06:00

faq_keymap.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

faq_misc.md

…

feature_advanced_keycodes.md

Deprecate some nonstandard mod & mod-tap keycode aliases (#25437)

2025-07-06 20:30:47 +10:00

feature_converters.md

…

feature_debounce_type.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

feature_eeprom.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

feature_layers.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

feature_layouts.md

…

feature_macros.md

Convert stray legacy warn/info docs panels (#24799)

2025-01-07 19:12:54 -08:00

feature_userspace.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

flashing.md

Added MCU support for ArteryTek AT32F415 (#23445)

2024-11-21 17:28:28 +11:00

fuse.txt

…

getting_started_docker.md

Allow running Docker container on MacOS (without in-container USB support) (#24412)

2025-01-16 06:36:20 +11:00

getting_started_github.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

getting_started_introduction.md

[docs] Align more keyboard placeholders (#25510)

2025-07-23 13:08:48 +01:00

getting_started_make_guide.md

[docs] Align more keyboard placeholders (#25510)

2025-07-23 13:08:48 +01:00

hand_wire.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

hardware_drivers.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

hardware_keyboard_guidelines.md

[docs] Align more keyboard placeholders (#25510)

2025-07-23 13:08:48 +01:00

how_a_matrix_works.md

…

how_keyboards_work.md

…

index.md

…

isp_flashing_guide.md

…

keycodes_basic.md

[DOCS] Fix keycodes_basic FastForward + Rewind #25685 (#25686)

2025-09-29 23:54:48 +01:00

keycodes_magic.md

…

keycodes_us_ansi_shifted.md

…

keycodes.md

[DOCS] Fix keycodes_basic FastForward + Rewind #25685 (#25686)

2025-09-29 23:54:48 +01:00

keymap.md

…

license_violations.md

More Yunzii notes regarding refusal to provide sources. (#25335)

2025-06-05 16:29:53 +01:00

mod_tap.md

Deprecate some nonstandard mod & mod-tap keycode aliases (#25437)

2025-07-06 20:30:47 +10:00

newbs_building_firmware_configurator.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

newbs_building_firmware_workflow.md

…

newbs_building_firmware.md

[docs] Align keyboard and keymap placeholders (#25509)

2025-07-23 04:33:37 +01:00

newbs_external_userspace.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

newbs_flashing.md

[docs] Align keyboard and keymap placeholders (#25509)

2025-07-23 04:33:37 +01:00

newbs_getting_started.md

Docs update for installing qmk with uv (#24995)

2025-05-07 15:41:37 +01:00

newbs_git_best_practices.md

…

newbs_git_resolving_merge_conflicts.md

…

newbs_git_resynchronize_a_branch.md

…

newbs_git_using_your_master_branch.md

…

newbs_learn_more_resources.md

…

newbs_testing_debugging.md

…

newbs.md

…

one_shot_keys.md

Add short aliases for OSM() (#25443)

2025-07-06 16:57:51 +10:00

other_eclipse.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

other_vscode.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

platformdev_blackpill_f4x1.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

platformdev_chibios_earlyinit.md

…

platformdev_proton_c.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

platformdev_rp2040.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

platformdev_selecting_arm_mcu.md

…

porting_your_keyboard_to_qmk.md

Correct link in porting_your_keyboard_to_qmk.md (#25635)

2025-09-09 19:44:47 -06:00

power.txt

…

pr_checklist.md

Update PR checklist notes on custom matrix (#25240)

2025-05-18 16:42:43 +01:00

proprietary_libs.md

Add proprietary libraries policy page. (#25532)

2025-08-01 23:26:30 +10:00

quantum_keycodes.md

…

quantum_painter_lvgl.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

quantum_painter_qff.md

Add compiler_support.h (#25274)

2025-05-22 23:31:15 +10:00

quantum_painter_qgf.md

Add compiler_support.h (#25274)

2025-05-22 23:31:15 +10:00

quantum_painter_rle.md

…

quantum_painter.md

[Docs] Fix example code in quantum_painter.md (#24897)

2025-03-01 14:01:30 -07:00

ref_functions.md

…

reference_configurator_support.md

[docs] Replace Imgur-hosted images (#25690)

2025-11-04 00:05:39 +00:00

reference_glossary.md

…

reference_info_json.md

Refactor battery driver (#25550)

2025-08-17 01:14:48 +01:00

reference_keymap_extras.md

Add keymap-extras for EurKEY layout (#24241)

2024-12-23 23:23:51 -08:00

squeezing_avr.md

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00

support_deprecation_policy.md

…

support.md

…

syllabus.md

…

tap_hold.md

[Docs] Tap-Hold examples (#24391)

2025-10-18 11:17:57 +01:00

understanding_qmk.md

Deprecate LAYOUT() macro in favor of JSON matrix definitions

2025-11-04 15:06:56 +08:00

unit_testing.md

[Core] get_keycode_string(): function to format keycodes as strings, for more readable debug logging. (#24787)

2025-03-19 20:45:56 +01:00

usb_nkro.txt

docs: fix misspellings (#25555)

2025-09-09 14:51:13 -07:00