summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2026-01-04docs/tap_hold.md fixes: Note that Chordal Hold supports multiple same-side ↵Pascal Getreuer1-2/+16
mods and fix heading for Speculative Hold. (#25924) * Note Chordal Hold supports multiple same-side mods. * Fix "Speculative Hold" heading from H3 -> H2.
2026-01-03Fix small typo in WS2812 driver doc (#25928)Ed Flanagan1-1/+1
`ws812` -> `ws2812`
2025-12-04[DOCS] Add `keycodes` to `info.json` docs. More precise matrix masking info ↵Jacek Królikowski1-1/+16
(#25801)
2025-12-04Simplify docs for Key Overrides config (#25787)tyler1-1/+1
2025-12-012025q4 develop changelog (#25845)Joel Challis7-65/+202
2025-11-27Merge remote-tracking branch 'origin/master' into developQMK Bot3-48/+22
2025-11-28QMK CLI Environment bootstrapper (#25038)Nick Brassel3-48/+22
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Pascal Getreuer <getreuer@google.com>
2025-11-23Reduce tap dance memory usage, move state out of data (#25415)Stephen Ostermiller2-3/+56
* Use less tap dance memory. Use dynamically allocated sparse array for tap dance state, dynamically allocate tap dance state when needed and free it when the tap dance is done. * new approach * Use null, check for null * Reformat with docker * Use uint8 with idx rather than uint16 with keycode in state * fix accidental change * reformat * Add null check * add documentation tip suggested by tzarc * Only allow tap dance state allocation on key down, not on key up Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Only allow tap dance allocation on key down, not on key up Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * add user action required section --------- Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2025-11-12Add PixArt PAW-3222 mouse sensor driver (#25763)ploopyco1-0/+17
2025-11-11[Feature Improvement]add option to keep layer state when recording dynamic ↵Chaser Huang1-6/+7
macros (#24418) * feat: add option to keep layer state when recording dynamic macros * Better option macro name and lint changes
2025-11-11Add I2C Transmit and Receive function (#25637)Drashna Jaelre1-0/+25
* feat: adds a transmit and receive i2c method * fix: address the i2c transmit and receive length on u16 * Add AVR/LUFA implementation Didn't add a progmem version, since that would only apply to receive. Figured it wasn't worth it, but can add. * Rearrange order of functions * Add docs * Fix doc gen error * Fix lint issues * fix more lint issues
2025-11-11[Core] Speculative Hold option for mod-taps: hold mods instantly while ↵Pascal Getreuer1-0/+33
unsettled. (#25572)
2025-11-06Guard remapping logic with MAGIC_ENABLE (#25537)フィルターペーパー1-20/+0
* Only perform key and mod remapping in keycode_config() and mod_config() when MAGIC_ENABLE is defined. * If not set, these functions now return the original keycode or modifier unchanged. * Reduces firmware size, and unnecessary code when MAGIC_ENABLE is not enabled. * Removed space saving suggestion with magic functions from squeezing AVR documentation
2025-11-06Rework converter docs (#18314)Joel Challis3-101/+369
2025-11-04Merge remote-tracking branch 'origin/master' into developQMK Bot1-2/+2
2025-11-04Deprecate LAYOUT() macro in favor of JSON matrix definitionsAndrew C1-2/+2
* 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-04Merge remote-tracking branch 'origin/master' into developQMK Bot64-51/+61
2025-11-04[docs] Replace Imgur-hosted images (#25690)James Young64-51/+61
2025-10-19Debounce: Deprecate num_rows parameter (#25632)フィルターペーパー2-2/+6
2025-10-18Fix drv haptics docs by using the correct function name (#25733)Boudewijn van Groos1-1/+1
2025-10-18Merge remote-tracking branch 'origin/master' into developQMK Bot1-38/+72
2025-10-18[Docs] Tap-Hold examples (#24391)Rin Jun Kit Liu1-38/+72
* Update tap_hold.md Minor grammar/punctuation changes; Added some more tap-hold examples; Added a link about home row mods to the reference near the end; Replaced directional quotation marks with symmetric variant, as this seem to be the only page using them; Standardised formatting of "tap-hold" (hyphenated is slightly more frequent in existing documentation, so I went with that), as well as "Mod-Tap"/"Layer-Tap". * Update docs/tap_hold.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/tap_hold.md Co-authored-by: Ryan <fauxpark@gmail.com> --------- Co-authored-by: Ryan <fauxpark@gmail.com>
2025-10-07[QP] Minor cleanup and support for RGB888 surface (#25706)Pablo Martínez1-0/+2
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-09-29Merge remote-tracking branch 'origin/master' into developQMK Bot2-4/+4
2025-09-29[DOCS] Fix keycodes_basic FastForward + Rewind #25685 (#25686)Jonas Eppard2-4/+4
2025-09-29Add LED/RGB Matrix flags API docs (#25673)Joel Challis3-0/+122
2025-09-29Add DD {LED,RGB}_MATRIX_DEFAULT_FLAGS support (#25671)Joel Challis1-0/+6
2025-09-22Add generic handling to cycle LED/RGB Matrix flags (#24649)Joel Challis1-0/+6
2025-09-10Merge remote-tracking branch 'origin/master' into developQMK Bot1-1/+1
2025-09-10Update data_driven_config.md (#25612)diegorodriguezv1-1/+1
2025-09-10Merge remote-tracking branch 'origin/master' into developQMK Bot1-1/+1
2025-09-09Correct link in porting_your_keyboard_to_qmk.md (#25635)diegorodriguezv1-1/+1
Fixed anchor
2025-09-10Merge remote-tracking branch 'origin/master' into developQMK Bot1-1/+1
2025-09-09Correct link in faq_general.md (#25640)diegorodriguezv1-1/+1
Updated the link to the QMK trademark page.
2025-09-09Merge remote-tracking branch 'origin/master' into developQMK Bot27-211/+216
2025-09-09docs: fix misspellings (#25555)François Magimel27-211/+216
* docs: fix misspellings * docs: do line breaks with HTML instead of spaces To remove trailing spaces and to avoid breaking things, line breaks can be done with the HTML br tag.
2025-09-09Merge remote-tracking branch 'origin/master' into developQMK Bot1-3/+4
2025-09-09Print build failures with `qmk mass-compile` and `qmk userspace-compile` if ↵Nick Brassel1-3/+4
requested (`-p`/`--print-failures`) (#25518)
2025-09-07Refactor debounce algorithm with static allocation (#25515)フィルターペーパー1-0/+3
* Refactor debounce counters with direct indexing * Refactor code to use array indexing for debounce_counters * Use global MATRIX_ROW_SHIFTER macro * Refactor debounce algorithm with static allocation * Converted arrays to static allocation * Standardised use of MATRIX_ROWS_PER_HAND for array sizing * Added Doxygen comments for primary debounce functions * Removed debounce_free() * Rewrite sym_defer_pr * Modernise code using sym_defer_pk as template * Format consistency with other current algorithms * Use shorter SPDX-License-Identifier * Remove ChibiOS core memory manager guard * Keep type definition within DEBOUNCE guard * Add change log * Minor optimisation refactor * Pre-calculate row_offset in per-key matrix loops * Add inline compiler hints * Improve readability with blank lines * Limit elapsed time to the maximum debounce value * Apply suggestions from code review Declare counters with "DEBOUNCE_ELAPSED" Co-authored-by: Joel Challis <git@zvecr.com> * Update change log to new breaking change date --------- Co-authored-by: Joel Challis <git@zvecr.com>
2025-09-07Update USBaspLoader ISP instructions (#25590)Ryan1-6/+10
2025-09-062025q3 develop changelog (#25597)Joel Challis6-53/+193
2025-08-17Refactor battery driver (#25550)Joel Challis4-45/+106
2025-08-10Migrate `helix` common configuration (#25433)Jack Sangdahl1-0/+37
* Initial tidying up of top level helix/ directory Align readme.md with template & provide more detailed PCB information Remove unused rules.mk Add common config.h file Update glcdfont.c with formatting and license header * Further migrations after PRs merged Move shared configuration to top level info.json and config.h More descriptive hardware compatibility * Add changelog * Align configuration between PCBs - Migrate beta & pico to use RGB Matrix - Move previously RGB Matrix-dependent OLED code in rev3/rev3.c to top level - Remove reundant OLED code in beta/beta.c - Remove RGBLight references * Update changelog with RGB Matrix configuration
2025-08-09Fix serial speed DD configuration & migrate keyboards (#25546)Jack Sangdahl1-3/+3
* Fix serial speed DD configuration - Fixes incorrect SOFT_SERIAL_SPEED mapping - Renames key split.soft_serial_speed -> split.serial.speed - Migrates keyoards that configure this, and remove configuration from keyboards that do not differ from the default behaviour - Add deprecation notice and migration support
2025-08-01Merge remote-tracking branch 'origin/master' into developQMK Bot2-2/+179
2025-08-01Add proprietary libraries policy page. (#25532)Nick Brassel2-2/+179
2025-07-23Merge remote-tracking branch 'origin/master' into developQMK Bot17-20/+20
2025-07-23[docs] Align more keyboard placeholders (#25510)Joel Challis17-20/+20
2025-07-23Merge remote-tracking branch 'origin/master' into developQMK Bot5-15/+15
2025-07-23[docs] Align keyboard and keymap placeholders (#25509)Joel Challis5-15/+15