jack c3b3f09702 [Docs] Tidy up keyboard guidelines (#25461) ...

* Initial

* Grammar

2025-07-08 13:17:33 -06:00

..

ChangeLog

2025 Q2 changelog (#25297)

2025-05-26 21:04:52 +10:00

drivers

[docs] WS2812: rewrite Open Drain section (#25454)

2025-07-07 13:12:11 -06:00

features

Fix invalid layer API usage in RGB Matrix docs (#25449)

2025-07-04 20:09:27 +01:00

public

Add EOL to non-keyboard files (#24990)

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

__capabilities_inc.md

Add embed to docs capabilities (#23698)

2024-05-12 03:26:11 +10:00

__capabilities.md

[docs] Remove gitbook directory (#23839)

2024-06-01 10:37:40 +10:00

_aliases.json

Revert removal of QK_OUTPUT_AUTO, fixup docs to reflect. (#24593)

2024-11-14 21:16:52 +11:00

_sidebar.json

2025 Q2 changelog (#25297)

2025-05-26 21:04:52 +10:00

api_development_environment.md

Add API documentation

2020-03-05 16:00:10 -08:00

api_development_overview.md

Fix typo in docs/api_development_overview.md (#24620)

2024-11-19 13:37:39 -07:00

api_docs.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

api_overview.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

arm_debugging.md

[Docs] fix docs (#7642)

2019-12-21 11:00:22 +00:00

breaking_changes_history.md

2025 Q2 changelog (#25297)

2025-05-26 21:04:52 +10:00

breaking_changes_instructions.md

Update Discord URL (#24283)

2024-08-15 14:37:27 +01:00

breaking_changes.md

2025 Q2 changelog (#25297)

2025-05-26 21:04:52 +10:00

chibios_upgrade_instructions.md

Update branch names to reflect configurator's new deployment. (#19999)

2023-03-03 14:16:06 +11:00

cli_commands.md

Deprecate qmk generate-compilation-database. (#25237)

2025-05-06 09:52:41 +10:00

cli_configuration.md

[docs] Fix code blocks overflowing page width (#23829)

2024-05-30 10:00:28 +01:00

cli_development.md

Align to latest CLI dependencies (#24553)

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

cli_tab_complete.md

[docs] Fix code blocks overflowing page width (#23829)

2024-05-30 10:00:28 +01:00

cli.md

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

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

coding_conventions_c.md

[Docs] Code markdown amendment (#21323)

2023-06-20 20:58:13 -06:00

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

Deprecate usb.force_nkro/FORCE_NKRO (#25262)

2025-05-14 22:02:43 +10:00

configurator_architecture.md

Architecture documentation for Configurator and API (#13935)

2021-08-10 07:47:53 -07:00

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

Remove suggestion of creating issues for unsupported keyboards. (#23918)

2024-06-14 00:23:57 +01:00

configurator_troubleshooting.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

contributing.md

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

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

custom_matrix.md

Remove matrix_init_quantum/matrix_scan_quantum (#19806)

2023-02-11 03:47:17 +00:00

custom_quantum_functions.md

Community modules (#24848)

2025-02-26 22:25:41 +11:00

data_driven_config.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

documentation_best_practices.md

[docs] Organize driver & feature docs into subfolders (#23848)

2024-06-02 12:42:24 +10:00

documentation_templates.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

driver_installation_zadig.md

Added MCU support for ArteryTek AT32F415 (#23445)

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

easy_maker.md

[docs] Organize driver & feature docs into subfolders (#23848)

2024-06-02 12:42:24 +10:00

faq_build.md

[docs] Organize driver & feature docs into subfolders (#23848)

2024-06-02 12:42:24 +10:00

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

Update Discord URL (#24283)

2024-08-15 14:37:27 +01:00

faq_keymap.md

[Docs] Remove references to bootmagic lite (#24369)

2024-09-06 17:30:54 +01:00

faq_misc.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

feature_advanced_keycodes.md

Clean up mod & mod-tap shortcuts (#25399)

2025-06-28 12:44:24 +10:00

feature_converters.md

Add svlinky converter (#24449)

2024-10-12 00:16:25 +01:00

feature_debounce_type.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

feature_eeprom.md

[Docs] Remove references to bootmagic lite (#24369)

2024-09-06 17:30:54 +01:00

feature_layers.md

[Feature] Add keycode PDF(layer) to set the default layer in EEPROM (#24630)

2024-11-23 10:09:34 +00:00

feature_layouts.md

[docs] Fix code blocks overflowing page width (#23829)

2024-05-30 10:00:28 +01:00

feature_macros.md

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

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

feature_userspace.md

[Docs] Link to awesome-qmk userspaces repository (#25357)

2025-06-27 14:23:05 -06:00

flashing.md

Added MCU support for ArteryTek AT32F415 (#23445)

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

fuse.txt

Ensure single newline at EOF for core files (#11310)

2020-12-28 04:36:32 +11:00

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

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

getting_started_introduction.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

getting_started_make_guide.md

[docs] Organize driver & feature docs into subfolders (#23848)

2024-06-02 12:42:24 +10:00

hand_wire.md

Remove direct docs.qmk.fm links from docs (#25113)

2025-04-08 12:31:17 +10:00

hardware_drivers.md

[docs] Organize driver & feature docs into subfolders (#23848)

2024-06-02 12:42:24 +10:00

hardware_keyboard_guidelines.md

[Docs] Tidy up keyboard guidelines (#25461)

2025-07-08 13:17:33 -06:00

how_a_matrix_works.md

[docs] Fix code blocks overflowing page width (#23829)

2024-05-30 10:00:28 +01:00

how_keyboards_work.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

index.md

Update Discord URL (#24283)

2024-08-15 14:37:27 +01:00

isp_flashing_guide.md

Docs theme updates (#23832)

2024-05-31 10:34:30 +10:00

keycodes_basic.md

[docs] Change GUI key references to "Meta" -> "Super" (#25394)

2025-06-22 12:33:53 +10:00

keycodes_magic.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

keycodes_us_ansi_shifted.md

[Docs] Address some typos (also in moonlander matrix.c) (#16248)

2022-02-06 17:36:44 +00:00

keycodes.md

Add short aliases for OSM() (#25443)

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

keymap.md

[docs] Fix code blocks overflowing page width (#23829)

2024-05-30 10:00:28 +01:00

license_violations.md

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

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

mod_tap.md

Clean up mod & mod-tap shortcuts (#25399)

2025-06-28 12:44:24 +10:00

newbs_building_firmware_configurator.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

newbs_building_firmware_workflow.md

Docs theme updates (#23832)

2024-05-31 10:34:30 +10:00

newbs_building_firmware.md

Clarify keymap location and format in newbs_building_firmware.md (#24663)

2024-12-22 12:23:14 -08:00

newbs_external_userspace.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

newbs_flashing.md

Update Discord URL (#24283)

2024-08-15 14:37:27 +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

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

newbs_git_resolving_merge_conflicts.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

newbs_git_resynchronize_a_branch.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

newbs_git_using_your_master_branch.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

newbs_learn_more_resources.md

[Docs] Refactor code examples (#18003)

2022-08-12 17:27:24 -07:00

newbs_testing_debugging.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

newbs.md

[docs] Fix dead link to keyboard list in newbs.md (#24579)

2024-11-09 09:49:11 -07:00

one_shot_keys.md

Add short aliases for OSM() (#25443)

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

other_eclipse.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

other_vscode.md

Deprecate qmk generate-compilation-database. (#25237)

2025-05-06 09:52:41 +10:00

platformdev_blackpill_f4x1.md

Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635)

2023-01-19 16:09:11 -07:00

platformdev_chibios_earlyinit.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

platformdev_proton_c.md

Add converter docs (#17593)

2022-07-08 22:49:16 +01:00

platformdev_rp2040.md

[docs] Organize driver & feature docs into subfolders (#23848)

2024-06-02 12:42:24 +10:00

platformdev_selecting_arm_mcu.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

porting_your_keyboard_to_qmk.md

qmk new-keyboard: separate dev board and MCU selection (#24548)

2024-11-21 17:22:14 +11:00

power.txt

Trim trailing whitespace

2017-12-09 10:46:11 -05:00

pr_checklist.md

Update PR checklist notes on custom matrix (#25240)

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

quantum_keycodes.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

quantum_painter_lvgl.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10: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

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

quantum_painter.md

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

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

ref_functions.md

Add easier way to set default single layer (#24376)

2024-10-06 21:39:21 +13:00

reference_configurator_support.md

Fix rendering of reference_configurator_support.md (#24629)

2024-11-21 18:46:36 +00:00

reference_glossary.md

[docs] Organize driver & feature docs into subfolders (#23848)

2024-06-02 12:42:24 +10:00

reference_info_json.md

Deprecate usb.force_nkro/FORCE_NKRO (#25262)

2025-05-14 22:02:43 +10:00

reference_keymap_extras.md

Add keymap-extras for EurKEY layout (#24241)

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

squeezing_avr.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

support_deprecation_policy.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10:00

support.md

Update Discord URL (#24283)

2024-08-15 14:37:27 +01:00

syllabus.md

[Docs] Remove references to bootmagic lite (#24369)

2024-09-06 17:30:54 +01:00

tap_hold.md

[Docs] Fix typo in Chordal Hold example JSON, comma to colon. (#25424)

2025-06-28 13:21:12 +10:00

understanding_qmk.md

Vitepress conversion of docs. (#23795)

2024-05-30 12:00:41 +10: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

convert docs to lowercase and underscores

2017-06-10 14:58:55 -04:00