docs: Document the new predefined behaviors

Reorganising the pages of the docs can be done in a followup PR. Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
feat: Add more predefined behaviors
2026-03-20 04:55:20 -05:00 · 2026-02-12 19:27:17 +00:00 · 2026-02-12 19:27:16 +00:00
73 changed files with 258 additions and 556 deletions
--- a/.github/workflows/ble-test.yml
+++ b/.github/workflows/ble-test.yml
@@ -21,7 +21,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
      - name: Find test directories
        id: test-dirs
        run: |
@@ -38,7 +38,7 @@ jobs:
      image: docker.io/zmkfirmware/zmk-build-arm:4.1
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
      - name: Cache west modules
        uses: actions/cache@v4
        env:
--- a/.github/workflows/build-user-config.yml
+++ b/.github/workflows/build-user-config.yml
@@ -30,28 +30,17 @@ jobs:
    name: Fetch Build Keyboards
    outputs:
      build_matrix: ${{ env.build_matrix }}
-      has_valid_build_matrix: ${{ steps.fetch.outputs.has_valid_build_matrix }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4

      - name: Fetch Build Matrix
-        id: fetch
        run: |
-          matrix_content=$(yq -oj -I0 '${{ inputs.build_matrix_path }}')
-
-          if [ -z "$matrix_content" ] || [ "$matrix_content" = "null" ]; then
-            echo "::notice file=${{inputs.build_matrix_path}},title=Empty build matrix file::To add a keyboard to the build, see https://zmk.dev/docs/user-setup#add-a-keyboard."
-            echo "has_valid_build_matrix=false" >> $GITHUB_OUTPUT
-          else
-            echo "build_matrix=$matrix_content" >> $GITHUB_ENV
-            echo "has_valid_build_matrix=true" >> $GITHUB_OUTPUT
-            echo "$matrix_content"
-          fi
+          echo "build_matrix=$(yq -oj -I0 '${{ inputs.build_matrix_path }}')" >> $GITHUB_ENV
+          yq -oj "${{ inputs.build_matrix_path }}"

  build:
    runs-on: ubuntu-latest
-    if: needs.matrix.outputs.has_valid_build_matrix == 'true'
    container:
      image: zmkfirmware/zmk-build-arm:stable
    needs: matrix
@@ -67,7 +56,7 @@ jobs:
          curl -fsSL https://deb.nodesource.com/setup_22.x | bash && apt install -y nodejs

      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4

      - name: Create build directory
        run: |
@@ -158,29 +147,6 @@ jobs:
          echo "See also the [list of released versions](https://github.com/zmkfirmware/zmk/releases)." >> $GITHUB_STEP_SUMMARY
          echo "If you wish to stay on main, check the most recent pending release PR for breaking changes. [Our blog](https://zmk.dev/blog) may have upgrade information if breaking changes are significant." >> $GITHUB_STEP_SUMMARY

-      - name: Check if building a board without explicit ZMK compat
-        if: always()
-        working-directory: "${{ env.base_dir }}/${{ inputs.config_path }}"
-        run: |
-          if ! (grep "CONFIG_ZMK_BOARD_COMPAT=y" "${{ env.build_dir }}/zephyr/.config" > /dev/null)
-          then
-            original_board=$(echo "${{ matrix.board }}" | sed -e 's$/.*$$')
-            west_board=$(west boards --board-root ${{ env.base_dir }}/zmk/app/module --board-root ${{ env.base_dir }}/zmk/app --board "${original_board}")
-            if [ -z "$west_board" ]; then
-              echo "Not found the board listed with west boards. Skipping further checking."
-              exit 0
-            fi
-
-            west boards --board-root ${{ env.base_dir }}/zmk/app/module --board-root ${{ env.base_dir }}/zmk/app --board "${original_board}" --format "{qualifiers}" | grep "zmk" > /dev/null
-            if [ $? -ne 0 ]
-            then
-              echo "::warning file=build/zephyr/.config,title=Missing ZMK Compat::The selected board does not report explicit ZMK compat. Please verify you've selected the correct board and ZMK variant if one exists"
-            else
-              echo "::error file=build/zephyr/.config,title=Missing ZMK Compat::The selected board is not set up for ZMK and there is a ZMK variant available. See https://zmk.dev/blog/2025/12/09/zephyr-4-1#zmk-board-variant."
-              exit 1
-            fi
-          fi
-
      - name: ${{ env.display_name }} Kconfig file
        run: |
          if [ -f "${{ env.build_dir }}/zephyr/.config" ]
@@ -224,7 +190,6 @@ jobs:

  merge:
    runs-on: ubuntu-latest
-    if: needs.matrix.outputs.has_valid_build_matrix == 'true'
    needs: build
    name: Merge Output Artifacts
    steps:
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -30,7 +30,7 @@ jobs:
        include: ${{ fromJSON(needs.compile-matrix.outputs.include-list) }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Cache west modules
@@ -187,7 +187,7 @@ jobs:
      core-include: ${{ steps.core-list.outputs.result }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Use Node.js
@@ -218,7 +218,7 @@ jobs:
      boards-include: ${{ steps.boards-list.outputs.result }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
      - name: Use Node.js
        uses: actions/setup-node@v4
        with:
@@ -346,7 +346,7 @@ jobs:
      organized-metadata: ${{ steps.organize-metadata.outputs.result }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Use Node.js
@@ -428,7 +428,7 @@ jobs:
      core-changes: ${{ steps.core-changes.outputs.result }}
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - uses: tj-actions/changed-files@9200e69727eb73eb060652b19946b8a2fdfb654b # pin to v45.0.8 due to https://github.com/tj-actions/changed-files/issues/2463 https://www.stepsecurity.io/blog/harden-runner-detection-tj-actions-changed-files-action-is-compromised
--- a/.github/workflows/doc-checks.yml
+++ b/.github/workflows/doc-checks.yml
@@ -14,7 +14,7 @@ jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
      - uses: bahmutov/npm-install@v1
        with:
          working-directory: docs
@@ -24,7 +24,7 @@ jobs:
  typecheck:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
      - uses: bahmutov/npm-install@v1
        with:
          working-directory: docs
--- a/.github/workflows/hardware-metadata-validation.yml
+++ b/.github/workflows/hardware-metadata-validation.yml
@@ -20,7 +20,7 @@ jobs:
    container:
      image: docker.io/zmkfirmware/zmk-dev-arm:4.1
    steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
      - name: Install dependencies
        run: pip install --break-system-packages -r app/scripts/requirements.txt
      - name: West init
--- a/.github/workflows/pre-commit.yml
+++ b/.github/workflows/pre-commit.yml
@@ -8,7 +8,7 @@ jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
--- a/.github/workflows/release-please.yml
+++ b/.github/workflows/release-please.yml
@@ -35,7 +35,7 @@ jobs:
      ZMK_RELEASE_PLEASE_TOKEN: ${{ secrets.ZMK_RELEASE_PLEASE_TOKEN }}
      VERSION: v${{ needs.handle-commit.outputs.major }}.${{ needs.handle-commit.outputs.minor }}
    steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4

      - name: Create major.minor branch
        if: ${{ needs.handle-commit.outputs.patch == '0' }}
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -23,7 +23,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
      - name: Find test directories
        id: test-dirs
        run: |
@@ -40,7 +40,7 @@ jobs:
      image: docker.io/zmkfirmware/zmk-build-arm:4.1
    steps:
      - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v4
      - name: Cache west modules
        uses: actions/cache@v4
        env:
--- a/app/Kconfig
+++ b/app/Kconfig
@@ -5,17 +5,6 @@ mainmenu "ZMK Firmware"

 menu "ZMK"

-config ZMK_BOARD_COMPAT
-    bool
-    help
-      Hidden symbol used to hint that a board has been specifically
-      set up with various ZMK requirements in mind, e.g. settings
-      storage, bootloader integration, etc.
-
-      Failure to set this will warn users they may want to verify they
-      used a ZMK variant of an upstream board, or are using a board
-      properly migrated to a newer ZMK version.
-
 menu "Basic Keyboard Setup"

 config ZMK_KEYBOARD_NAME
--- a/app/boards/adafruit/kb2040/Kconfig.adafruit_kb2040
+++ b/app/boards/adafruit/kb2040/Kconfig.adafruit_kb2040
@@ -1,9 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: MIT
-
-config BOARD_ADAFRUIT_KB2040
-    select ZMK_BOARD_COMPAT if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
-    imply RETAINED_MEM if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
-    imply RETENTION if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_ADAFRUIT_KB2040_RP2040_ZMK
-
--- a/app/boards/adafruit/qt_py_rp2040/Kconfig.adafruit_qt_py_rp2040
+++ b/app/boards/adafruit/qt_py_rp2040/Kconfig.adafruit_qt_py_rp2040
@@ -1,9 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: MIT
-
-config BOARD_ADAFRUIT_QT_PY_RP2040
-    select ZMK_BOARD_COMPAT if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
-    imply RETAINED_MEM if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
-    imply RETENTION if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_ADAFRUIT_QT_PY_RP2040_RP2040_ZMK
-
--- a/app/boards/boardsource/blok/Kconfig.boardsource_blok
+++ b/app/boards/boardsource/blok/Kconfig.boardsource_blok
@@ -1,9 +0,0 @@
-# Copyright (c) 2026 Pete Johanson
-# SPDX-License-Identifier: MIT
-
-config BOARD_BOARDSOURCE_BLOK
-    select ZMK_BOARD_COMPAT if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
-    imply RETAINED_MEM if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
-    imply RETENTION if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_BOARDSOURCE_BLOK_RP2040_ZMK
-
--- a/app/boards/joric/nrfmicro/Kconfig.nrfmicro
+++ b/app/boards/joric/nrfmicro/Kconfig.nrfmicro
@@ -7,7 +7,6 @@ config BOARD_NRFMICRO
    select SOC_NRF52840_QIAA if BOARD_NRFMICRO_NRF52840_ZMK
    select SOC_NRF52840_QIAA if BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK
    select SOC_NRF52833_QIAA if BOARD_NRFMICRO_NRF52833_ZMK
-    select ZMK_BOARD_COMPAT if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
    imply RETAINED_MEM if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
    imply RETENTION if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
    imply RETENTION_BOOT_MODE if BOARD_NRFMICRO_NRF52840_ZMK || BOARD_NRFMICRO_NRF52840_FLIPPED_ZMK || BOARD_NRFMICRO_NRF52833_ZMK
--- a/app/boards/jpconstantineau/bluemicro840/Kconfig.bluemicro840
+++ b/app/boards/jpconstantineau/bluemicro840/Kconfig.bluemicro840
@@ -3,7 +3,6 @@

 config BOARD_BLUEMICRO840
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_BLUEMICRO840_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_BLUEMICRO840_NRF52840_ZMK
    imply RETENTION if BOARD_BLUEMICRO840_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_BLUEMICRO840_NRF52840_ZMK
--- a/app/boards/kbdfans/tofu65/Kconfig.tofu65
+++ b/app/boards/kbdfans/tofu65/Kconfig.tofu65
@@ -3,7 +3,6 @@

 config BOARD_TOFU65
    select SOC_RP2040
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/keebio/bdn9/Kconfig.bdn9
+++ b/app/boards/keebio/bdn9/Kconfig.bdn9
@@ -3,4 +3,3 @@

 config BOARD_BDN9
    select SOC_STM32F072XB
-    select ZMK_BOARD_COMPAT
--- a/app/boards/keycapsss/puchi_ble/Kconfig.puchi_ble
+++ b/app/boards/keycapsss/puchi_ble/Kconfig.puchi_ble
@@ -5,7 +5,6 @@

 config BOARD_PUCHI_BLE
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_PUCHI_BLE_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_PUCHI_BLE_NRF52840_ZMK
    imply RETENTION if BOARD_PUCHI_BLE_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_PUCHI_BLE_NRF52840_ZMK
--- a/app/boards/kinesis/adv360pro/Kconfig.adv360pro_left
+++ b/app/boards/kinesis/adv360pro/Kconfig.adv360pro_left
@@ -5,7 +5,6 @@

 config BOARD_ADV360PRO_LEFT
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
-    imply RETENTION_BOOT_MODE
+    imply RETENTION_BOOT_MODE
--- a/app/boards/kinesis/adv360pro/Kconfig.adv360pro_right
+++ b/app/boards/kinesis/adv360pro/Kconfig.adv360pro_right
@@ -5,7 +5,6 @@

 config BOARD_ADV360PRO_RIGHT
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
-    imply RETENTION_BOOT_MODE
+    imply RETENTION_BOOT_MODE
--- a/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_left
+++ b/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_left
@@ -5,7 +5,6 @@

 config BOARD_CORNEISH_ZEN_LEFT
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_right
+++ b/app/boards/lowprokb/corneish_zen/Kconfig.corneish_zen_right
@@ -5,7 +5,6 @@

 config BOARD_CORNEISH_ZEN_RIGHT
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/makerdiary/nrf52840_m2/Kconfig.nrf52840_m2
+++ b/app/boards/makerdiary/nrf52840_m2/Kconfig.nrf52840_m2
@@ -3,7 +3,6 @@

 config BOARD_NRF52840_M2
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_NRF52840_M2_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_NRF52840_M2_NRF52840_ZMK
    imply RETENTION if BOARD_NRF52840_M2_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_NRF52840_M2_NRF52840_ZMK
--- a/app/boards/mechwild/pillbug/Kconfig.pillbug
+++ b/app/boards/mechwild/pillbug/Kconfig.pillbug
@@ -3,7 +3,6 @@

 config BOARD_PILLBUG
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_PILLBUG_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_PILLBUG_NRF52840_ZMK
    imply RETENTION if BOARD_PILLBUG_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_PILLBUG_NRF52840_ZMK
--- a/app/boards/mechwild/pillbug/board.yml
+++ b/app/boards/mechwild/pillbug/board.yml
@@ -1,5 +1,5 @@
 board:
-  extend: pillbug
+  name: pillbug
  variants:
    - name: zmk
      qualifier: nrf52840
--- a/app/boards/moergo/glove80/Kconfig.glove80_lh
+++ b/app/boards/moergo/glove80/Kconfig.glove80_lh
@@ -3,7 +3,6 @@

 config BOARD_GLOVE80_LH
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/moergo/glove80/Kconfig.glove80_rh
+++ b/app/boards/moergo/glove80/Kconfig.glove80_rh
@@ -3,7 +3,6 @@

 config BOARD_GLOVE80_RH
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/nicekeyboards/nice60/Kconfig.nice60
+++ b/app/boards/nicekeyboards/nice60/Kconfig.nice60
@@ -3,7 +3,6 @@

 config BOARD_NICE60
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_NICE60_NRF52840_ZMK
-    imply RETAINED_MEM if BOARD_NICE60_NRF52840_ZMK
-    imply RETENTION if BOARD_NICE60_NRF52840_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_NICE60_NRF52840_ZMK
+    imply RETAINED_MEM
+    imply RETENTION
+    imply RETENTION_BOOT_MODE
--- a/app/boards/nicekeyboards/nice_nano/Kconfig.nice_nano
+++ b/app/boards/nicekeyboards/nice_nano/Kconfig.nice_nano
@@ -3,7 +3,6 @@

 config BOARD_NICE_NANO
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_NICE_NANO_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_NICE_NANO_NRF52840_ZMK
    imply RETENTION if BOARD_NICE_NANO_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_NICE_NANO_NRF52840_ZMK
--- a/app/boards/nordic/nrf52840dk/Kconfig.nrf52840dk
+++ b/app/boards/nordic/nrf52840dk/Kconfig.nrf52840dk
@@ -1,4 +1,3 @@

 config BOARD_NRF52840DK
    select SOC_NRF52840_QIAA if BOARD_NRF52840DK_NRF52840_ZMK
-    select ZMK_BOARD_COMPAT if BOARD_NRF52840DK_NRF52840_ZMK
--- a/app/boards/olkb/planck/Kconfig.planck
+++ b/app/boards/olkb/planck/Kconfig.planck
@@ -4,5 +4,5 @@
 # SPDX-License-Identifier: MIT

 config BOARD_PLANCK
+    bool "Planck Keyboard"
    select SOC_STM32F303XC
-    select ZMK_BOARD_COMPAT
--- a/app/boards/olkb/preonic/Kconfig.preonic
+++ b/app/boards/olkb/preonic/Kconfig.preonic
@@ -5,4 +5,3 @@

 config BOARD_PREONIC
    select SOC_STM32F303XC
-    select ZMK_BOARD_COMPAT
--- a/app/boards/pierrechevalier83/ferris/Kconfig.ferris
+++ b/app/boards/pierrechevalier83/ferris/Kconfig.ferris
@@ -5,7 +5,6 @@

 config BOARD_FERRIS
    select SOC_STM32F072XB
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt60/Kconfig.bt60
+++ b/app/boards/polarityworks/bt60/Kconfig.bt60
@@ -5,7 +5,6 @@

 config BOARD_BT60
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt60/Kconfig.bt60_hs
+++ b/app/boards/polarityworks/bt60/Kconfig.bt60_hs
@@ -5,7 +5,6 @@

 config BOARD_BT60_HS
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt65/Kconfig.bt65
+++ b/app/boards/polarityworks/bt65/Kconfig.bt65
@@ -5,7 +5,6 @@

 config BOARD_BT65
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/polarityworks/bt75/Kconfig.bt75
+++ b/app/boards/polarityworks/bt75/Kconfig.bt75
@@ -5,7 +5,6 @@

 config BOARD_BT75
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT
    imply RETAINED_MEM
    imply RETENTION
    imply RETENTION_BOOT_MODE
--- a/app/boards/qmk/proton_c/Kconfig.proton_c
+++ b/app/boards/qmk/proton_c/Kconfig.proton_c
@@ -1,6 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: Apache-2.0
-
-config BOARD_PROTON_C
-    select ZMK_BOARD_COMPAT
-
--- a/app/boards/raspberrypi/rpi_pico/Kconfig.rpi_pico
+++ b/app/boards/raspberrypi/rpi_pico/Kconfig.rpi_pico
@@ -1,10 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: MIT
-
-config BOARD_RPI_PICO
-    select SOC_RP2040
-    select ZMK_BOARD_COMPAT if BOARD_RPI_PICO_RP2040_ZMK
-    imply RETAINED_MEM if BOARD_RPI_PICO_RP2040_ZMK
-    imply RETENTION if BOARD_RPI_PICO_RP2040_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_RPI_PICO_RP2040_ZMK
-
--- a/app/boards/seeed/seeeduino_xiao/Kconfig.seeeduino_xiao
+++ b/app/boards/seeed/seeeduino_xiao/Kconfig.seeeduino_xiao
@@ -1,9 +0,0 @@
-# Copyright (c) 2026 Pete Johanson
-# SPDX-License-Identifier: MIT
-
-config BOARD_SEEEDUINO_XIAO
-    select ZMK_BOARD_COMPAT if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
-    imply RETAINED_MEM if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
-    imply RETENTION if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_SEEEDUINO_XIAO_SAMD21G18A_ZMK
-
--- a/app/boards/seeed/xiao_ble/Kconfig.xiao_ble
+++ b/app/boards/seeed/xiao_ble/Kconfig.xiao_ble
@@ -1,10 +0,0 @@
-# Copyright (c) 2026 Pete Johanson
-# SPDX-License-Identifier: MIT
-
-config BOARD_XIAO_BLE
-    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_XIAO_BLE_NRF52840_ZMK
-    imply RETAINED_MEM if BOARD_XIAO_BLE_NRF52840_ZMK
-    imply RETENTION if BOARD_XIAO_BLE_NRF52840_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_XIAO_BLE_NRF52840_ZMK
-
--- a/app/boards/shields/nice_view/Kconfig.defconfig
+++ b/app/boards/shields/nice_view/Kconfig.defconfig
@@ -26,7 +26,6 @@ endchoice

 config LV_Z_MEM_POOL_SIZE
    default 8192 if ZMK_DISPLAY_STATUS_SCREEN_CUSTOM
-    default 5120 if ZMK_DISPLAY_STATUS_SCREEN_BUILT_IN

 config ZMK_DISPLAY_STATUS_SCREEN_CUSTOM
    imply NICE_VIEW_WIDGET_STATUS
--- a/app/boards/shields/sofle/sofle.keymap
+++ b/app/boards/shields/sofle/sofle.keymap
@@ -78,7 +78,7 @@
 //                |      |       |       |      |      |  |      |      |      |       |      |
            bindings = <
 &bt BT_CLR &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4                  &trans    &trans    &trans   &trans    &trans  &trans
-&trans     &kp INS      &kp PSCRN    &kp K_CMENU  &trans       &trans                        &kp PG_UP &trans    &kp UP   &trans    &trans  &trans
+&trans     &kp INS      &kp PSCRN    &kp K_CMENU  &trans       &trans                        &kp PG_UP &trans    &kp UP   &trans    &kp N0  &trans
 &trans     &kp LALT     &kp LCTRL    &kp LSHFT    &trans       &kp CLCK                      &kp PG_DN &kp LEFT  &kp DOWN &kp RIGHT &kp DEL &kp BSPC
 &trans     &kp K_UNDO   &kp K_CUT    &kp K_COPY   &kp K_PASTE  &trans        &trans  &trans  &trans    &trans    &trans   &trans    &trans  &trans
                        &trans       &trans       &trans       &trans        &trans  &trans  &trans    &trans    &trans   &trans
--- a/app/boards/sparkfun/pro_micro_rp2040/Kconfig.sparkfun_pro_micro_rp2040
+++ b/app/boards/sparkfun/pro_micro_rp2040/Kconfig.sparkfun_pro_micro_rp2040
@@ -1,10 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: MIT
-
-config BOARD_SPARKFUN_PRO_MICRO_RP2040
-    select ZMK_BOARD_COMPAT if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
-    imply RETAINED_MEM if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
-    imply RETENTION if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
-    imply RETENTION_BOOT_MODE if BOARD_SPARKFUN_PRO_MICRO_RP2040_RP2040_ZMK
-
-
--- a/app/boards/weact/blackpill_f401cc/Kconfig.blackpill_f401cc
+++ b/app/boards/weact/blackpill_f401cc/Kconfig.blackpill_f401cc
@@ -1,6 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: MIT
-
-config BOARD_BLACKPILL_F401CC
-    select ZMK_BOARD_COMPAT
-
--- a/app/boards/weact/blackpill_f401ce/Kconfig.blackpill_f401ce
+++ b/app/boards/weact/blackpill_f401ce/Kconfig.blackpill_f401ce
@@ -1,6 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: MIT
-
-config BOARD_BLACKPILL_F401CE
-    select ZMK_BOARD_COMPAT
-
--- a/app/boards/weact/blackpill_f411ce/Kconfig.blackpill_f411ce
+++ b/app/boards/weact/blackpill_f411ce/Kconfig.blackpill_f411ce
@@ -1,6 +0,0 @@
-# Copyright (c) 2026 The ZMK Contributors
-# SPDX-License-Identifier: MIT
-
-config BOARD_BLACKPILL_F411CE
-    select ZMK_BOARD_COMPAT
-
--- a/app/boards/zhiayang/mikoto/Kconfig.mikoto
+++ b/app/boards/zhiayang/mikoto/Kconfig.mikoto
@@ -3,7 +3,6 @@

 config BOARD_MIKOTO
    select SOC_NRF52840_QIAA
-    select ZMK_BOARD_COMPAT if BOARD_MIKOTO_NRF52840_ZMK
    imply RETAINED_MEM if BOARD_MIKOTO_NRF52840_ZMK
    imply RETENTION if BOARD_MIKOTO_NRF52840_ZMK
    imply RETENTION_BOOT_MODE if BOARD_MIKOTO_NRF52840_ZMK
--- a/app/dts/behaviors/key_tap.dtsi
+++ b/app/dts/behaviors/key_tap.dtsi
@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2025 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <dt-bindings/zmk/behaviors.h>
+
+/ {
+    macros {
+#if ZMK_BEHAVIOR_OMIT(KTAP)
+    /omit-if-no-ref/
+#endif
+        ktap: key_tap {
+            compatible = "zmk,behavior-macro-one-param";
+            #binding-cells = <1>;
+            display-name = "Key Tap";
+            bindings = <&macro_param_1to1>, <&kp MACRO_PLACEHOLDER>;
+            tap-ms = <30>;
+        };
+    };
+};
--- a/app/dts/behaviors/key_toggle.dtsi
+++ b/app/dts/behaviors/key_toggle.dtsi
@@ -16,5 +16,25 @@
            #binding-cells = <1>;
            display-name = "Key Toggle";
        };
+
+#if ZMK_BEHAVIOR_OMIT(KT_ON)
+        /omit-if-no-ref/
+#endif
+        kt_on: key_toggle_on {
+            compatible = "zmk,behavior-key-toggle";
+            #binding-cells = <1>;
+            display-name = "Key Toggle On";
+            toggle-mode = "on";
+        };
+
+#if ZMK_BEHAVIOR_OMIT(KT_OFF)
+        /omit-if-no-ref/
+#endif
+        kt_off: key_toggle_off {
+            compatible = "zmk,behavior-key-toggle";
+            #binding-cells = <1>;
+            display-name = "Key Toggle Off";
+            toggle-mode = "off";
+        };
    };
 };
--- a/app/dts/behaviors/toggle_layer.dtsi
+++ b/app/dts/behaviors/toggle_layer.dtsi
@@ -17,5 +17,25 @@
            display-name = "Toggle Layer";
            locking;
        };
+
+#if ZMK_BEHAVIOR_OMIT(TOG_ON)
+        /omit-if-no-ref/
+#endif
+        tog_on: toggle_layer_on {
+            compatible = "zmk,behavior-toggle-layer";
+            #binding-cells = <1>;
+            display-name = "Toggle Layer On";
+            toggle-mode = "on";
+        };
+
+#if ZMK_BEHAVIOR_OMIT(TOG_OFF)
+        /omit-if-no-ref/
+#endif
+        tog_off: toggle_layer_off {
+            compatible = "zmk,behavior-toggle-layer";
+            #binding-cells = <1>;
+            display-name = "Toggle Layer Off";
+            toggle-mode = "off";
+        };
    };
 };
--- a/app/module/drivers/kscan/Kconfig
+++ b/app/module/drivers/kscan/Kconfig
@@ -61,7 +61,7 @@ config ZMK_KSCAN_MATRIX_WAIT_BEFORE_INPUTS

 config ZMK_KSCAN_MATRIX_WAIT_BETWEEN_OUTPUTS
    int "Ticks to wait between each output when scanning"
-    default 1 if SOC_RP2040 || SOC_SERIES_RP2350
+    default 1 if SOC_RP2040
    default 0
    help
        When iterating over each output to drive it active, read inputs, then set
--- a/app/module/drivers/sensor/ec11/ec11.h
+++ b/app/module/drivers/sensor/ec11/ec11.h
@@ -33,7 +33,7 @@ struct ec11_data {
    const struct sensor_trigger *trigger;

 #if defined(CONFIG_EC11_TRIGGER_OWN_THREAD)
-    K_KERNEL_STACK_MEMBER(thread_stack, CONFIG_EC11_THREAD_STACK_SIZE);
+    K_THREAD_STACK_MEMBER(thread_stack, CONFIG_EC11_THREAD_STACK_SIZE);
    struct k_sem gpio_sem;
    struct k_thread thread;
 #elif defined(CONFIG_EC11_TRIGGER_GLOBAL_THREAD)
--- a/app/src/split/bluetooth/Kconfig
+++ b/app/src/split/bluetooth/Kconfig
@@ -22,8 +22,8 @@ config ZMK_SPLIT_ROLE_CENTRAL
    select BT_SCAN_WITH_IDENTITY

 # Bump this value needed for concurrent GATT discovery of splits
-config BT_ATT_TX_COUNT
-    default 10 if ZMK_SPLIT_ROLE_CENTRAL
+config BT_L2CAP_TX_BUF_COUNT
+    default 5 if ZMK_SPLIT_ROLE_CENTRAL

 if ZMK_SPLIT_ROLE_CENTRAL

--- a/app/src/studio/Kconfig
+++ b/app/src/studio/Kconfig
@@ -59,20 +59,11 @@ config ZMK_STUDIO_TRANSPORT_UART
    select RING_BUFFER
    default y if $(dt_chosen_enabled,$(DT_CHOSEN_ZMK_STUDIO_RPC_UART))

-if ZMK_STUDIO_TRANSPORT_UART
-
 config ZMK_STUDIO_TRANSPORT_UART_RX_STACK_SIZE
    int "RX Stack Size"
    depends on !UART_INTERRUPT_DRIVEN
    default 512

-config ZMK_STUDIO_TRANSPORT_UART_RX_PRIORITY
-    int "RX Thread Priority"
-    depends on !UART_INTERRUPT_DRIVEN
-    default 9
-
-endif
-
 config ZMK_STUDIO_TRANSPORT_BLE
    bool "BLE (GATT)"
    select RING_BUFFER
@@ -80,12 +71,9 @@ config ZMK_STUDIO_TRANSPORT_BLE
    depends on ZMK_BLE
    default y

-
 config BT_CONN_TX_MAX
    default 64 if ZMK_STUDIO_TRANSPORT_BLE

-if ZMK_STUDIO_TRANSPORT_BLE
-
 config ZMK_STUDIO_TRANSPORT_BLE_PREF_LATENCY
    int "BLE Transport preferred latency"
    default 10
@@ -93,8 +81,6 @@ config ZMK_STUDIO_TRANSPORT_BLE_PREF_LATENCY
      When the studio UI is connected, a lower latency can be requested in order
      to make the interactions between keyboard and studio faster.

-endif
-
 endmenu

 config ZMK_STUDIO_RPC_THREAD_STACK_SIZE
--- a/app/src/studio/uart_rpc_transport.c
+++ b/app/src/studio/uart_rpc_transport.c
@@ -65,7 +65,7 @@ static void uart_rx_main(void) {
 }

 K_THREAD_DEFINE(uart_transport_read_thread, CONFIG_ZMK_STUDIO_TRANSPORT_UART_RX_STACK_SIZE,
-                uart_rx_main, NULL, NULL, NULL, CONFIG_ZMK_STUDIO_TRANSPORT_UART_RX_PRIORITY, 0, 0);
+                uart_rx_main, NULL, NULL, NULL, K_LOWEST_APPLICATION_THREAD_PRIO, 0, 0);

 #endif

--- a/app/tests/toggle-layer/behavior_keymap.dtsi
+++ b/app/tests/toggle-layer/behavior_keymap.dtsi
@@ -3,16 +3,6 @@
 #include <dt-bindings/zmk/kscan_mock.h>

 / {
-    behaviors {
-        tog_off: toggle_layer_off_only {
-            compatible = "zmk,behavior-toggle-layer";
-            #binding-cells = <1>;
-            display-name = "Toggle Layer Off";
-            toggle-mode = "off";
-            locking;
-        };
-    };
-
    keymap {
        compatible = "zmk,keymap";

--- a/docs/blog/2025-12-09-zephyr-4-1.md
+++ b/docs/blog/2025-12-09-zephyr-4-1.md
@@ -80,36 +80,36 @@ As a result, all board definitions found in the ZMK tree now must be used with a
 As part of this change, ZMK is now using board/shield revisions, rather than duplicate board/shield definitions. This means that instead of having e.g. `nice_nano`, and `nice_nano_v2`, we only have `nice_nano`, which by default points to the `2.0.0` revision. To point to the original Nice!Nano V1, you would need to use `nice_nano@1.0.0` where you would have previously used `nice_nano`. Of course, you could also put `nice_nano@2.0.0` if you wished to make that explicit, instead of merely replacing `nice_nano_v2` with `nice_nano`. Some boards, such as the `nrfmicro`, also have additional _board qualifiers_ such as the choice between multiple SoCs. Board qualifiers must always be specified, and do not have defaults. See [Zephyr's overview](https://docs.zephyrproject.org/4.1.0/hardware/porting/board_porting.html#board-terminology) for more information on board qualifiers. The below table provides an overview of some of the differences in in-tree boards we have in ZMK, and how they are selected in the new build system. The shorthand shows the minimum needed to build with a specific board, taking into account defaults.

 - nice!nano (`nice_nano`)
-  - `nice_nano` -> `nice_nano@1.0.0//zmk` (short: `nice_nano@1//zmk`)
-  - `nice_nano_v2` -> `nice_nano@2.0.0//zmk` (short: `nice_nano//zmk`)
+  - `nice_nano` -> `nice_nano@1.0.0` (short: `nice_nano@1`)
+  - `nice_nano_v2` -> `nice_nano@2.0.0` (short: `nice_nano`)
 - nRFMicro (`nrfmicro/nrf52840`)
-  - `nrfmicro_11` -> `nrfmicro@1.1.0/nrf52840/zmk` (short: `nrfmicro@1.1/nrf52840/zmk`)
-  - `nrfmicro_11_flipped` -> `nrfmicro@1.1.0/nrf52840/flipped_zmk` (short: `nrfmicro@1.1/nrf52840/flipped_zmk`)
-  - `nrfmicro_13` -> `nrfmicro@1.3.0/nrf52840/zmk` (short: `nrfmicro/nrf52840/zmk`)
-  - `nrfmicro_13_52833` -> `nrfmicro@1.3.0/nrf52833/zmk` (short: `nrfmicro/nrf52833/zmk`)
+  - `nrfmicro_11` -> `nrfmicro@1.1.0/nrf52840` (short: `nrfmicro@1.1/nrf52840`)
+  - `nrfmicro_11_flipped` -> `nrfmicro@1.1.0/nrf52840/flipped` (short: `nrfmicro@1.1/nrf52840/flipped`)
+  - `nrfmicro_13` -> `nrfmicro@1.3.0/nrf52840` (short: `nrfmicro/nrf52840`)
+  - `nrfmicro_13_52833` -> `nrfmicro@1.3.0/nrf52833` (short: `nrfmicro/nrf52833`)
 - Mikoto (`mikoto`)
-  - `mikoto` -> `mikoto@5.20.0//zmk` (short: `mikoto//zmk`)
-  - `mikoto@6.1` -> `mikoto@6.1.0//zmk` (short: `mikoto@6//zmk`)
-  - `mikoto@7.2` -> `mikoto@7.2.0//zmk` (short: `mikoto@7//zmk`)
+  - `mikoto` -> `mikoto@5.20.0` (short: `mikoto`)
+  - `mikoto@6.1` -> `mikoto@6.1.0` (short: `mikoto@6`)
+  - `mikoto@7.2` -> `mikoto@7.2.0` (short: `mikoto@7`)
 - XIAO RP2040 (`xiao_rp2040`)
-  - `seeeduino_xiao_rp2040` -> `xiao_rp2040//zmk`
+  - `seeeduino_xiao_rp2040` -> `xiao_rp2040`
 - XIAO nRF52840/BLE (`xiao_ble`)
-  - `seeeduino_xiao_ble` -> `xiao_ble//zmk`
+  - `seeeduino_xiao_ble` -> `xiao_ble`
 - BT60 (`bt60`)
-  - `bt60_v1` -> `bt60@1.0.0//zmk`
-  - `bt60_v2` -> `bt60@2.0.0//zmk`
-  - `bt60_hs` -> `bt60_hs//zmk`
+  - `bt60_v1` -> `bt60@1.0.0`
+  - `bt60_v2` -> `bt60@2.0.0`
+  - `bt60_hs` -> `bt60_hs`
 - Planck (`planck`)
-  - `planck_rev6` -> `planck//zmk`
+  - `planck_rev6` -> `planck`
 - BDN9 (`bdn9`)
-  - `bdn9_rev2` -> `bdn9//zmk`
+  - `bdn9_rev2` -> `bdn9`
 - Ferris Rev2 (`ferris`)
-  - `ferris_rev02` -> `ferris@2.0.0//zmk` (short: `ferris//zmk`)
+  - `ferris_rev02` -> `ferris@2.0.0` (short: `ferris`)
 - Corne-ish Zen (`corneish_zen`)
-  - `corneish_zen_v2_left` -> `corneish_zen_left@2.0.0//zmk` (short: `corneish_zen_left//zmk`)
-  - `corneish_zen_v2_right` -> `corneish_zen_right@2.0.0//zmk` (short: `corneish_zen_right//zmk`)
-  - `corneish_zen_v1_left` -> `corneish_zen_left@1.0.0//zmk` (short: `corneish_zen_left@1//zmk`)
-  - `corneish_zen_v1_right` -> `corneish_zen_right@1.0.0//zmk` (short: `corneish_zen_right@1//zmk`)
+  - `corneish_zen_v2_left` -> `corneish_zen_left@2.0.0` (short: `corneish_zen_left`)
+  - `corneish_zen_v2_right` -> `corneish_zen_right@2.0.0` (short: `corneish_zen_right`)
+  - `corneish_zen_v1_left` -> `corneish_zen_left@1.0.0` (short: `corneish_zen_left@1`)
+  - `corneish_zen_v1_right` -> `corneish_zen_right@1.0.0` (short: `corneish_zen_right@1`)

 The boards above are those which have changed in ZMK's tree, with the addition of the very popular XIAO series. For other boards in Zephyr's tree, please refer to the Zephyr documentation or source files directly.

--- a/docs/docs/config/system.md
+++ b/docs/docs/config/system.md
@@ -13,12 +13,11 @@ Definition file: [zmk/app/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/

 ### General

-| Config                      | Type   | Description                                                                                                                                    | Default |
-| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
-| `CONFIG_ZMK_BOARD_COMPAT`   | bool   | A special config for boards to enable. This helps check if users have accidentally used an upstream Zephyr board without ZMK additions applied | n       |
-| `CONFIG_ZMK_KEYBOARD_NAME`  | string | The name of the keyboard (max 16 characters)                                                                                                   |         |
-| `CONFIG_ZMK_WPM`            | bool   | Enable calculating words per minute                                                                                                            | n       |
-| `CONFIG_HEAP_MEM_POOL_SIZE` | int    | Size of the heap memory pool                                                                                                                   | 8192    |
+| Config                      | Type   | Description                                  | Default |
+| --------------------------- | ------ | -------------------------------------------- | ------- |
+| `CONFIG_ZMK_KEYBOARD_NAME`  | string | The name of the keyboard (max 16 characters) |         |
+| `CONFIG_ZMK_WPM`            | bool   | Enable calculating words per minute          | n       |
+| `CONFIG_HEAP_MEM_POOL_SIZE` | int    | Size of the heap memory pool                 | 8192    |

 :::info

--- a/docs/docs/development/hardware-integration/dongle.mdx
+++ b/docs/docs/development/hardware-integration/dongle.mdx
@@ -177,7 +177,7 @@ There are three commonly found possibilities:
 Copy the file into your dongle's folder. Then import the file, assign the matrix transform to it, and select it in the `chosen` node:

 ```dts
-#include "my_keyboard-layouts.dtsi"
+#import "my_keyboard-layouts.dtsi"

 &physical_layout0 {
    transform = <&default_transform>;
--- a/docs/docs/development/hardware-integration/index.mdx
+++ b/docs/docs/development/hardware-integration/index.mdx
@@ -111,7 +111,7 @@ And other miscellaneous ones:
 - A `<keyboard_name>.zmk.yml` file containing [metadata](hardware-metadata-files.md) for the keyboard.

 See Zephyr's [board porting guide](https://docs.zephyrproject.org/4.1.0/hardware/porting/board_porting.html) for information on creating a new board.
-See also our [new board guide](new-board.md) for information on creating a ZMK-compatible board variant.
+Also see the [new keyboard shield guide](new-shield.mdx#shield-overlays) for information on parts of the devicetree specifically related to ZMK.

 [^1]:
    Parts of these files can live in separate `.dtsi` files (typically in the same directory) that are then `#include`d in the files, to reduce duplication or improve organization.
--- a/docs/docs/development/hardware-integration/new-board.md
+++ b/docs/docs/development/hardware-integration/new-board.md
@@ -1,187 +0,0 @@
---
-title: New Board
---
-
-This guide will walk through the necessary steps to write a [board](./index.mdx#boards--shields) suitable for use with ZMK. Boards used with ZMK fall into two categories:
-
- Boards with interconnects, such as `nice_nano` or `seeed_xiao`. Such boards will (active development of ZMK aside) always be used with a shield to create a keyboard.
- Boards that are themselves keyboards, such as `bt75` or `ferris`.
-
-Some keyboards are boards but also have interconnects for modular add-ons. These are considered as keyboard-boards for the purpose of this guide. Details on adding an interconnect for modular add-ons are considered out of scope.
-
-## Boards Included in ZMK
-
-Boards with interconnects can be considered for inclusion to the tree of ZMK. If this is your aim, it is vital that you read through our [clean room policy](../contributing/clean-room.md).
-
-Boards with interconnects that are included with ZMK are generally:
-
- Reliably commercially available as individual units
- In regular use across multiple shields (i.e. not niche)
-
-Popular open source designs which are not being sold can also be considered for inclusion.
-
-There also exist many boards in the tree of upstream Zephyr. We generally accept ZMK-variants of these boards into our tree as well.
-
-## New ZMK Module Repository
-
-Regardless of whether you aim to include the board in ZMK or not, you should first write the definition for it in a module. A new ZMK module repository can be created from a template.
-
-:::note
-This guide assumes you already have a configured GitHub account. If you don't yet have one, go ahead and [sign up](https://github.com/join) before continuing.
-:::
-
-Follow these steps to create your new repository:
-
- Visit https://github.com/zmkfirmware/unified-zmk-config-template
- Click the green "Use this template" button
- In the drop down that opens, click "Use this template".
- In the following screen, provide the following information:
-  - A repository name, e.g. `my-board-module`.
-  - A brief description, e.g. `ZMK Support For MyBoard`.
-  - Select Public or Private, depending on your preference.
- Click the green "Create repository" button
-
-The repository is a combination of the directories and files required of a ZMK config, and those required of a shield module.
-This enables the use of GitHub Actions to test that the shield is defined correctly.
-See also the page on [module creation](../module-creation.md) for a reference on exactly which file structure and files are required for a ZMK keyboard module.
-
-We recommend that you take this moment to name your module according to our [convention](../module-creation.md), i.e. your `zephyr/module.yml` file should begin with
-
-```yaml title="zephyr/module.yml"
-name: zmk-keyboard-<keyboard_name>
-```
-
-if it is a keyboard, or
-
-```yaml title="zephyr/module.yml"
-name: zmk-component-<board_name>
-```
-
-if it is a board with an interconnect.
-
-## Write a Zephyr Board Definition
-
-Zephyr has a guide on writing a board [here](https://docs.zephyrproject.org/4.1.0/hardware/porting/board_porting.html). Follow this guide to create a Zephyr-compatible board. Use the `boards` folder of your ZMK module as a base.
-
-Once your board definition has been written, we recommend flashing some [Zephyr samples](https://docs.zephyrproject.org/4.1.0/samples/basic/basic.html) to it, to verify that it is working.
-
-Flashing Zephyr samples can also be very helpful when troubleshooting/testing the functionality of extra features such as LED ICs, Bluetooth, or various sensor ICs.
-
-## Write a ZMK Variant of Zephyr Board
-
-To make a board fully compatible with ZMK, you will be creating a ZMK variant of the Zephyr board you made in the previous step. Perform the below actions for each board you've defined, in the case of multi-board split keyboards.
-
-### Add Variant to board.yml
-
-Edit your existing `board.yml` file to add the variant:
-
-```yaml title="board.yml"
-board:
-  ...
-  socs:
-  - name: <soc-1>
-    variants:
-    - name: zmk
-```
-
-### Add Kconfig for ZMK Variant
-
-Add a file to your board's folder called `<your-board>_zmk_defconfig`. This file will be used to set Kconfig flags specific to the ZMK variant.
-
-:::warning
-Make sure you know what each Kconfig flag does before you enable it. Some flags may be incompatible with certain hardware, or have other adverse effects.
-:::
-
-These flags are typically a subset of the following:
-
-```yaml title="<your-board>_zmk_defconfig"
-# SPDX-License-Identifier: <your license>
-
-# Enable MPU
-CONFIG_ARM_MPU=y
-
-CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC=125000000
-
-# Enable reset by default
-CONFIG_RESET=y
-
-# Enable clock control by default
-CONFIG_CLOCK_CONTROL=y
-
-# Code partition needed to target the correct flash range
-CONFIG_USE_DT_CODE_PARTITION=y
-
-# Output UF2 by default, native bootloader supports it.
-CONFIG_BUILD_OUTPUT_UF2=y
-
-# USB HID
-CONFIG_ZMK_USB=y
-
-# BLE HID
-CONFIG_ZMK_BLE=y
-
-# Bootloader Support
-CONFIG_RETAINED_MEM=y
-CONFIG_RETENTION=y
-CONFIG_RETENTION_BOOT_MODE=y
-
-# Settings Support
-CONFIG_MPU_ALLOW_FLASH_WRITE=y
-CONFIG_NVS=y
-CONFIG_SETTINGS_NVS=y
-CONFIG_FLASH=y
-CONFIG_FLASH_PAGE_LAYOUT=y
-CONFIG_FLASH_MAP=y
-
-
-# Enable HW stack protection
-CONFIG_HW_STACK_PROTECTION=y
-
-# Enable GPIO
-CONFIG_GPIO=y
-
-# Defaults for matrix scanning to avoid interrupt issues
-CONFIG_ZMK_KSCAN_MATRIX_POLLING=y
-```
-
-Note that none of our in-tree boards have all of the above flags set. We recommend referencing the Kconfig flags from an existing in-tree board with the same SoC as the one you are using for your initial definition, making sure you understand what each flag does.
-
-### Add Devicetree for ZMK Variant
-
-```dts title="<your-board>_zmk.dts
-/*
- * Copyright (c) <year> <you>
- *
- * SPDX-License-Identifier: <your license>
- */
-
-// Include the base board definition
-#include <../boards/<vendor or you>/<board folder name>/<your board>.dts>
-// Include predefined boot mode settings, e.g.
-#include <arm/raspberrypi/rp2040-boot-mode-retention.dtsi>
-
-// Disable UART nodes if they are not actively in use (wired split) as they increase power draw
-&uart0 { status = "disabled"; };
-
-// Reduce the code partition section of the memory and add a storage partition to store ZMK Studio changes
-&code_partition {
-    reg = <0x100 (DT_SIZE_M(2) - 0x100 - DT_SIZE_K(512))>;
-};
-&flash0 {
-    reg = <0x10000000 DT_SIZE_M(2)>;
-    partitions {
-        storage_partition: partition@180000 {
-            reg = <0x180000 DT_SIZE_K(512)>;
-            read-only;
-        };
-    };
-};
-```
-
-See [here](./bootloader/index.mdx) for bootloader instructions for other SoCs. Depending on your SoC and design you may need to make further changes. Please refer to our in-tree boards with the same SoC as yours as examples.
-
-## Next Steps
-
-If your board is a keyboard, continue from [the `Kconfig.defconfig` step](https://zmk.dev/docs/development/hardware-integration/new-shield?keyboard-type=unibody#kconfigdefconfig) of the new shield guide. Use your ZMK variant's devicetree instead of the overlay file which would be used for a shield.
-
-If your board is a board with an interconnect, your next step should be to write a [tester shield](../../troubleshooting/hardware-issues.mdx#identifying-issues). Such a shield should be the bare minimum shield to verify that your board works with ZMK.
--- a/docs/docs/development/new-behavior.mdx
+++ b/docs/docs/development/new-behavior.mdx
@@ -202,7 +202,7 @@ values={[
 * SPDX-License-Identifier: MIT
 */

-#define DT_DRV_COMPAT zmk_behavior_<name_of_behavior>
+#define DT_DRV_COMPAT zmk_<name_of_behavior>

 // Dependencies
 #include <zephyr/device.h>
@@ -247,7 +247,7 @@ static int on_<name_of_behavior>_binding_released(struct zmk_behavior_binding *b
 // API struct
 static const struct behavior_driver_api <name_of_behavior>_driver_api = {
    .binding_pressed = on_<name_of_behavior>_binding_pressed,
-    .binding_released = on_<name_of_behavior>_binding_released,
+    .binding_released = on_<name_of_behavior>_binding_pressed,
 };

 BEHAVIOR_DT_INST_DEFINE(0,                                                // Instance Number (0)
@@ -273,7 +273,7 @@ BEHAVIOR_DT_INST_DEFINE(0,                                                // Ins
 * SPDX-License-Identifier: MIT
 */

-#define DT_DRV_COMPAT zmk_behavior_<name_of_behavior>
+#define DT_DRV_COMPAT zmk_<name_of_behavior>

 // Dependencies
 #include <zephyr/device.h>
@@ -318,30 +318,29 @@ static int on_<name_of_behavior>_binding_released(struct zmk_behavior_binding *b
 // API struct
 static const struct behavior_driver_api <name_of_behavior>_driver_api = {
    .binding_pressed = on_<name_of_behavior>_binding_pressed,
-    .binding_released = on_<name_of_behavior>_binding_released,
+    .binding_released = on_<name_of_behavior>_binding_pressed,
 };

-#define <NAME_OF_BEHAVIOR>_INST(n)                                                                                       \
-    static struct behavior_<name_of_behavior>_data_##n {                                                                 \
-        .data_param1 = foo1,                                                                                             \
-        .data_param2 = foo2,                                                                                             \
-        .data_param3 = foo3,                                                                                             \
-    };                                                                                                                   \
-                                                                                                                         \
-    static struct behavior_<name_of_behavior>_config_##n {                                                               \
-        .config_param1 = bar1,                                                                                           \
-        .config_param2 = bar2,                                                                                           \
-        .config_param3 = bar3,                                                                                           \
-    };                                                                                                                   \
-                                                                                                                         \
-    BEHAVIOR_DT_INST_DEFINE(n,                                  /* Instance Number (Automatically populated by macro) */ \
-                            <name_of_behavior>_init,            /* Initialization Function */                            \
-                            NULL,                               /* Power Management Device Pointer */                    \
-                            &<name_of_behavior>_data_##n,       /* Behavior Data Pointer */                              \
-                            &<name_of_behavior>_config_##n,     /* Behavior Configuration Pointer */                     \
-                            POST_KERNEL,                        /* Initialization Level */                               \
-                            CONFIG_KERNEL_INIT_PRIORITY_DEFAULT /* Device Priority */                                    \
-                            &<name_of_behavior>_driver_api);    /* API struct */                                         \
+#define <NAME_OF_BEHAVIOR>_INST(n)                                            \
+    static struct behavior_<name_of_behavior>_data_##n {                      \
+        .data_param1 = foo1;                                                  \
+        .data_param2 = foo2;                                                  \
+        .data_param3 = foo3;                                                  \
+    };                                                                        \
+                                                                              \
+    static struct behavior_<name_of_behavior>_config_##n {                    \
+        .config_param1 = bar1;                                                \
+        .config_param2 = bar2;                                                \
+        .config_param3 = bar3;                                                \
+    };                                                                        \
+                                                                              \
+    BEHAVIOR_DT_INST_DEFINE(n,                                                \ // Instance Number (Automatically populated by macro)
+                            <name_of_behavior>_init,                          \ // Initialization Function
+                            NULL,                                             \ // Power Management Device Pointer
+                            &<name_of_behavior>_data_##n,                     \ // Behavior Data Pointer
+                            &<name_of_behavior>_config_##n,                   \ // Behavior Configuration Pointer
+                            POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT  \ // Initialization Level, Device Priority
+                            &<name_of_behavior>_driver_api);                    // API struct

 DT_INST_FOREACH_STATUS_OKAY(<NAME_OF_BEHAVIOR>_INST)

--- a/docs/docs/keymaps/_footnotes/macos-international.mdx
+++ b/docs/docs/keymaps/_footnotes/macos-international.mdx
@@ -1 +0,0 @@
-On macOS in Japanese mode, `INTERNATIONAL1` is ろ (ro, bottom right on the Apple Japanese keyboard) and `INTERNATIONAL3` is ¥ (yen, top right).
--- a/docs/docs/keymaps/_footnotes/macos-language.mdx
+++ b/docs/docs/keymaps/_footnotes/macos-language.mdx
@@ -1 +0,0 @@
-On macOS in Japanese mode, `LANG1` is かな (kana, to turn on Japanese IME) and `LANG2` is 英数 (eisuu, to turn off the IME).
--- a/docs/docs/keymaps/behaviors/hold-tap.mdx
+++ b/docs/docs/keymaps/behaviors/hold-tap.mdx
@@ -208,8 +208,8 @@ A popular method of implementing Autoshift in ZMK involves a C-preprocessor macr
        as: auto_shift {
            compatible = "zmk,behavior-hold-tap";
            #binding-cells = <2>;
-            tapping-term-ms = <135>;
-            quick-tap-ms = <0>;
+            tapping_term_ms = <135>;
+            quick_tap_ms = <0>;
            flavor = "tap-preferred";
            bindings = <&kp>, <&kp>;
        };
@@ -299,7 +299,7 @@ One workaround is to create a [macro](macros.md) that invokes those behaviors an
 By default, when another key is pressed while a hold-tap is held, it will trigger the "hold" behavior even if `tapping-term-ms` has not been exceeded yet.
 We refer to the interaction of pressing one key while another is held as the "interrupt", and the way the hold-tap resolves is referred to as its "interrupt flavor".

-This default interrupt flavor is called "hold-preferred". While this flavor may work well for a ctrl/escape key, it might not be well suited for home-row mods or layer-taps. For this reason, ZMK defines multiple interrupt flavors which hold-tap behaviors can be configured with, listed below:
+This default interrupt flavor is called "hold-preferred". While this flavor may work well for a ctrl/escape key, but it might not be well suited for home-row mods or layer-taps. For this reason, ZMK defines multiple interrupt flavors which hold-tap behaviors can be configured with, listed below:

 - The "hold-preferred" flavor triggers the hold behavior when the `tapping-term-ms` has expired or another key is pressed.
 - The "balanced" flavor will trigger the hold behavior when the `tapping-term-ms` has expired or another key is pressed _and_ released while the hold-tap is held.
@@ -312,7 +312,7 @@ When the hold-tap key is released and the hold behavior has not been triggered,

 #### Comparison to QMK

-The `hold-preferred` flavor works similarly to the `HOLD_ON_OTHER_KEY_PRESS` setting in QMK.
+The `hold-preferred` flavor works similar to the `HOLD_ON_OTHER_KEY_PRESS` setting in QMK.
 The `balanced` flavor is similar to the `PERMISSIVE_HOLD` setting, and the `tap-preferred` flavor is the QMK default.

 ```dts
@@ -333,10 +333,6 @@ By default this behavior is disabled.
 };
 ```

-#### Comparison to QMK
-
-QMK has a parameter called `QUICK_TAP_TERM`, but its semantics are slightly different. In QMK, it is the time interval between releasing the first key and pressing the second key whereas in ZMK, it is the time interval between pressing the first and second keys. Therefore you might want to use a larger value for `quick-tap-ms` compared to the value used in QMK.
-
 ### `require-prior-idle-ms`

 If a hold-tap is pressed within `require-prior-idle-ms` of another non-modifier _key_ (not behavior), then the hold-tap will always resolve in a tap.
--- a/docs/docs/keymaps/behaviors/index.mdx
+++ b/docs/docs/keymaps/behaviors/index.mdx
@@ -11,15 +11,18 @@ Below is a summary of pre-defined behavior bindings and user-definable behaviors

 ## Key Press Behaviors

-| Binding       | Behavior                                      | Description                                                                                                                                                                                                                                       |
-| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `&kp`         | [Key Press](key-press.md)                     | Send keycodes to the connected host when a key is pressed                                                                                                                                                                                         |
-| `&mt`         | [Mod Tap](hold-tap.mdx#mod-tap)               | Sends a different key press depending on whether a key is held or tapped                                                                                                                                                                          |
-| `&kt`         | [Key Toggle](key-toggle.md)                   | Toggles the press of a key. If the key is not currently pressed, key toggle will press it, holding it until the key toggle is pressed again or the key is released in some other way. If the key is currently pressed, key toggle will release it |
-| `&sk`         | [Sticky Key](sticky-key.md)                   | Stays pressed until another key is pressed, then is released. It is often used for modifier keys like shift, which allows typing capital letters without holding it down                                                                          |
-| `&gresc`      | [Grave Escape](mod-morph.md#behavior-binding) | Sends Grave Accent `` ` `` keycode if shift or GUI is held, sends Escape keycode otherwise                                                                                                                                                        |
-| `&caps_word`  | [Caps Word](caps-word.md)                     | Behaves similar to caps lock, but automatically deactivates when any key not in a continue list is pressed, or if the caps word key is pressed again                                                                                              |
-| `&key_repeat` | [Key Repeat](key-repeat.md)                   | Sends again whatever keycode was last sent                                                                                                                                                                                                        |
+| Binding       | Behavior                                             | Description                                                                                                                                                                                                                                       |
+| ------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `&kp`         | [Key Press](key-press.md)                            | Send keycodes to the connected host when a key is pressed or released                                                                                                                                                                             |
+| `&ktap`       | [Key Tap](key-press.md#key-tap)                      | Send keycodes to the connected host when a key is pressed                                                                                                                                                                                         |
+| `&mt`         | [Mod Tap](hold-tap.mdx#mod-tap)                      | Sends a different key press depending on whether a key is held or tapped                                                                                                                                                                          |
+| `&kt`         | [Key Toggle](key-toggle.md)                          | Toggles the press of a key. If the key is not currently pressed, key toggle will press it, holding it until the key toggle is pressed again or the key is released in some other way. If the key is currently pressed, key toggle will release it |
+| `&kt_on`      | [Key Toggle](key-toggle.md#toggle-on-and-toggle-off) | Toggles on a key (sends keycode press event) on press                                                                                                                                                                                             |
+| `&kt_off`     | [Key Toggle](key-toggle.md#toggle-on-and-toggle-off) | Toggles off a key (sends keycode release event) on press                                                                                                                                                                                          |
+| `&sk`         | [Sticky Key](sticky-key.md)                          | Stays pressed until another key is pressed, then is released. It is often used for modifier keys like shift, which allows typing capital letters without holding it down                                                                          |
+| `&gresc`      | [Grave Escape](mod-morph.md#behavior-binding)        | Sends Grave Accent `` ` `` keycode if shift or GUI is held, sends Escape keycode otherwise                                                                                                                                                        |
+| `&caps_word`  | [Caps Word](caps-word.md)                            | Behaves similar to caps lock, but automatically deactivates when any key not in a continue list is pressed, or if the caps word key is pressed again                                                                                              |
+| `&key_repeat` | [Key Repeat](key-repeat.md)                          | Sends again whatever keycode was last sent                                                                                                                                                                                                        |

 ## Miscellaneous Behaviors

@@ -30,13 +33,15 @@ Below is a summary of pre-defined behavior bindings and user-definable behaviors

 ## Layer Navigation Behaviors

-| Binding | Behavior                                     | Description                                                                                              |
-| ------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `&mo`   | [Momentary Layer](layers.md#momentary-layer) | Enables a layer while a key is pressed                                                                   |
-| `&lt`   | [Layer-tap](layers.md#layer-tap)             | Enables a layer when a key is held, and outputs a key press when the key is only tapped for a short time |
-| `&to`   | [To Layer](layers.md#to-layer)               | Enables a layer and disables all other layers except the default layer                                   |
-| `&tog`  | [Toggle Layer](layers.md#toggle-layer)       | Enables a layer until the layer is manually disabled                                                     |
-| `&sl`   | [Sticky Layer](sticky-layer.md)              | Activates a layer until another key is pressed, then deactivates it                                      |
+| Binding    | Behavior                                           | Description                                                                                              |
+| ---------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
+| `&mo`      | [Momentary Layer](layers.md#momentary-layer)       | Enables a layer while a key is pressed                                                                   |
+| `&lt`      | [Layer-tap](layers.md#layer-tap)                   | Enables a layer when a key is held, and outputs a key press when the key is only tapped for a short time |
+| `&to`      | [To Layer](layers.md#to-layer)                     | Enables a layer and disables all other layers except the default layer                                   |
+| `&tog`     | [Toggle Layer](layers.md#toggle-layer)             | Enables a layer until the layer is manually disabled                                                     |
+| `&tog_on`  | [Toggle Layer](layers.md#toggle-on-and-toggle-off) | Enables a layer even if the layer is already enabled                                                     |
+| `&tog_off` | [Toggle Layer](layers.md#toggle-on-and-toggle-off) | Disables a layer even if the layer is already disabled                                                   |
+| `&sl`      | [Sticky Layer](sticky-layer.md)                    | Activates a layer until another key is pressed, then deactivates it                                      |

 ## Mouse Emulation Behaviors

--- a/docs/docs/keymaps/behaviors/key-press.md
+++ b/docs/docs/keymaps/behaviors/key-press.md
@@ -47,3 +47,32 @@ Example:
 ```dts
 &kp A
 ```
+
+## Key Tap
+
+The "key tap" behavior will send a press followed by a release when you press the behavior, and will do nothing when you release the behavior.
+
+### Behavior Binding
+
+- Reference: `&ktap`
+- Parameter: The keycode usage ID from the usage page, e.g. `N4` or `A`
+
+Example:
+
+```dts
+&ktap A
+```
+
+#### Configuration
+
+You can adjust the tap duration, i.e. the time between press and release of the key, by changing the `tap-ms` property:
+
+```dts
+&ktap {
+    tap-ms = <30>; // This is the value already set by default
+};
+```
+
+:::info
+Internally, the key tap behavior is a very simple [macro](./macros.md#defining-parameterized-macros).
+:::
--- a/docs/docs/keymaps/behaviors/key-toggle.md
+++ b/docs/docs/keymaps/behaviors/key-toggle.md
@@ -25,24 +25,11 @@ Example:
 You can use any keycode that works for `&kp` as parameter to `&kt`, however, [modified keys](../modifiers.mdx#modifier-functions) such as `LA(A)` will be toggled based on the status of the base keycode (in this case `A`).
 In other words, modifiers are ignored when determining whether or not the key is currently pressed.

-### Configuration
+### Toggle On and Toggle Off

-#### Toggle mode
+For state-independent toggles, there exist two further behaviors:

-If you wish to ensure that a key is pressed or released, rather than merely toggling, then you can do so with the `toggle-mode` property.
-Define a new behavior and assign `"on"` or `"off"` to `toggle-mode`:
+- `&kt_on`: Toggles a keycode on, even if it is already on.
+- `&kt_off`: Toggles a keycode off, even if it is already off.

-```dts
-/ {
-    behaviors {
-        kt_on: key_toggle_on_only {
-            compatible = "zmk,behavior-key-toggle";
-            #binding-cells = <1>;
-            display-name = "Key Toggle On";
-            toggle-mode = "on";
-        };
-    };
-};
-```
-
-You can then use `&kt_on` in place of `&kt` whenever you wish to only toggle a key on, and not toggle it off. An `"off"` version of the behavior can be defined similarly.
+Use these just as you would use `&kt`.
--- a/docs/docs/keymaps/behaviors/layers.md
+++ b/docs/docs/keymaps/behaviors/layers.md
@@ -67,28 +67,14 @@ Example:
 &tog 3
 ```

-### Configuration
+### Toggle On and Toggle Off

-#### Toggle mode
+For state-independent toggles, there exist two further behaviors:

-If you wish to ensure that a layer is toggled on or off specifically, rather than switching between the two states, then you can do so with the `toggle-mode` property.
-Define a new behavior and assign `"on"` or `"off"` to `toggle-mode`:
+- `&tog_on`: Toggles a layer on, even if it is already on.
+- `&tog_off`: Toggles a layer off, even if it is already off.

-```dts
-/ {
-    behaviors {
-        tog_on: toggle_layer_on_only {
-            compatible = "zmk,behavior-toggle-layer";
-            #binding-cells = <1>;
-            display-name = "Toggle Layer On";
-            toggle-mode = "on";
-            locking;
-        };
-    };
-};
-```
-
-You can then use `&tog_on` in place of `&tog` whenever you wish to only toggle a layer on, and not toggle it off. An `"off"` version of the behavior can be defined similarly.
+Use these just as you would use `&tog`.

 ## Layer Locking

@@ -96,7 +82,13 @@ When the behaviors `&to` and `&tog` toggle a layer on, they will "lock" the laye

 In particular, if you activate a layer momentarily using e.g. `&mo 1`, tapping e.g. `&tog 1` as defined above will prevent the layer from deactivating after releasing `&mo 1`. You can then press `&tog 1` again to deactivate the layer.

-For custom toggle, to, and momentary layer behaviors, this can be enabled by giving your behavior the `locking;` property.
+You can remove the locking property from `&to` and `&tog` if you wanted them to be interruptable by `&mo`:
+
+```dts
+&to {
+  /delete-property/ locking;
+};
+```

 ## Conditional Layers

--- a/docs/docs/keymaps/behaviors/macros.md
+++ b/docs/docs/keymaps/behaviors/macros.md
@@ -192,6 +192,25 @@ Parameterized macros must be defined using specific values for the `compatible`
 };
 ```

+An example of a simple parameterized macro is `&ktap`, which is defined as:
+
+```dts
+/ {
+    macros {
+        ktap: key_tap {
+            compatible = "zmk,behavior-macro-one-param";
+            #binding-cells = <1>;
+            display-name = "Key Tap";
+            bindings = <&macro_param_1to1>, <&kp MACRO_PLACEHOLDER>;
+            tap-ms = <30>;
+        };
+    };
+};
+
+```
+
+This behavior is already pre-defined as `&ktap`, so you don't need to define it in your keymap to use it.
+
 ### Parameters, Bindings and Controls

 There are special macro controls which must be used in order to forward received parameters to the macro's `bindings`. These controls are "one shot" and will determine how received parameters are used on the very next (non-macro control) behavior in the macro's `bindings` list.
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -158,7 +158,6 @@ module.exports = {
            "development/hardware-integration/encoders",
            "development/hardware-integration/soft-off-setup",
            "development/hardware-integration/pointing",
-            "development/hardware-integration/new-board",
            "development/hardware-integration/battery",
            {
              type: "category",
--- a/docs/src/data/footnotes.js
+++ b/docs/src/data/footnotes.js
@@ -4,8 +4,6 @@
 * SPDX-License-Identifier: CC-BY-NC-SA-4.0
 */

-import macosLanguage from "@site/docs/keymaps/_footnotes/macos-language.mdx";
-import macosInternational from "@site/docs/keymaps/_footnotes/macos-international.mdx";
 import example from "@site/docs/keymaps/_footnotes/example.mdx";
 import iosApplication from "@site/docs/keymaps/_footnotes/ios-application.mdx";
 import iosPower from "@site/docs/keymaps/_footnotes/ios-power.mdx";
@@ -15,8 +13,6 @@ import macosUndoRedo from "@site/docs/keymaps/_footnotes/macos-undo-redo.mdx";
 import globe from "@site/docs/keymaps/_footnotes/globe.mdx";

 export default {
-  macosLanguage,
-  macosInternational,
  example,
  iosApplication,
  iosPower,
--- a/docs/src/data/hid.js
+++ b/docs/src/data/hid.js
@@ -3396,12 +3396,10 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
-    footnotes: {
-      macos: ["macosInternational"],
-    },
+    footnotes: {},
  },
  {
    names: ["INTERNATIONAL_2", "INT2", "INT_KATAKANAHIRAGANA", "INT_KANA"],
@@ -3419,7 +3417,7 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3440,12 +3438,10 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
-    footnotes: {
-      macos: ["macosInternational"],
-    },
+    footnotes: {},
  },
  {
    names: ["INTERNATIONAL_4", "INT4", "INT_HENKAN"],
@@ -3463,7 +3459,7 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3484,7 +3480,7 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3505,7 +3501,7 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3526,7 +3522,7 @@ export default [
      windows: null,
      linux: false,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3547,7 +3543,7 @@ export default [
      windows: null,
      linux: false,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3568,7 +3564,7 @@ export default [
      windows: null,
      linux: false,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3589,12 +3585,10 @@ export default [
      windows: true,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
-    footnotes: {
-      macos: ["macosLanguage"],
-    },
+    footnotes: {},
  },
  {
    names: ["LANGUAGE_2", "LANG2", "LANG_HANJA"],
@@ -3612,12 +3606,10 @@ export default [
      windows: true,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
-    footnotes: {
-      macos: ["macosLanguage"],
-    },
+    footnotes: {},
  },
  {
    names: ["LANGUAGE_3", "LANG3", "LANG_KATAKANA"],
@@ -3635,7 +3627,7 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3656,7 +3648,7 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3677,7 +3669,7 @@ export default [
      windows: false,
      linux: true,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3698,7 +3690,7 @@ export default [
      windows: null,
      linux: false,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3719,7 +3711,7 @@ export default [
      windows: null,
      linux: false,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3740,7 +3732,7 @@ export default [
      windows: null,
      linux: false,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -3761,7 +3753,7 @@ export default [
      windows: null,
      linux: false,
      android: false,
-      macos: true,
+      macos: null,
      ios: null,
    },
    footnotes: {},
@@ -7897,7 +7889,7 @@ export default [
    documentation: "https://usb.org/sites/default/files/hut1_2.pdf#page=153",
    os: {
      windows: null,
-      linux: false,
+      linux: null,
      android: null,
      macos: true,
      ios: true,
Author	SHA1	Message	Date
Nicolas Munnich	bc577ffbbd	docs: Document the new predefined behaviors Reorganising the pages of the docs can be done in a followup PR. Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>	2026-02-12 19:27:17 +00:00
Nicolas Munnich	a05f5699dd	feat: Add more predefined behaviors Adds predefined kt_on, kt_off, tog_on, tog_off, ktap behaviors.	2026-02-12 19:27:16 +00:00
				`@@ -1 +0,0 @@`
				On macOS in Japanese mode, `INTERNATIONAL1` is ろ (ro, bottom right on the Apple Japanese keyboard) and `INTERNATIONAL3` is ¥ (yen, top right).
				`@@ -1 +0,0 @@`
				On macOS in Japanese mode, `LANG1` is かな (kana, to turn on Japanese IME) and `LANG2` is 英数 (eisuu, to turn off the IME).