remove some outdated changes

Co-Authored-By: Ryan <fauxpark@gmail.com>

.gitattributes

@@ -92,4 +92,3 @@ GRAPHICS
 # hex files
 *.hex binary
 *.eep binary
-nix/sources.nix linguist-generated=true

.github/workflows/api.yml

@@ -7,12 +7,11 @@ on:
     paths:
     - 'keyboards/**'
     - 'layouts/community/**'
-  workflow_dispatch:
 
 jobs:
   api_data:
     runs-on: ubuntu-latest
-    container: qmkfm/qmk_cli
+    container: qmkfm/base_container
 
     # protect against those who develop with their fork on master
     if: github.repository == 'qmk/qmk_firmware'
@@ -26,13 +25,18 @@ jobs:
     - name: Generate API Data
       run: qmk generate-api
 
+    - name: Install rsync
+      run: |
+        apt-get update && apt-get install -y rsync
+
     - name: Upload API Data
-      uses: jakejarvis/s3-sync-action@master
+      uses: JamesIves/github-pages-deploy-action@3.7.1
       with:
-        args: --acl public-read --follow-symlinks --delete
-      env:
-        AWS_S3_BUCKET: ${{ secrets.API_SPACE_MASTER }}
-        AWS_ACCESS_KEY_ID: ${{ secrets.SPACES_ACCESS_KEY }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.SPACES_SECRET_KEY }}
-        AWS_S3_ENDPOINT: https://nyc3.digitaloceanspaces.com
-        SOURCE_DIR: 'api_data'
+        ACCESS_TOKEN: ${{ secrets.API_TOKEN_GITHUB }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        BRANCH: main
+        FOLDER: api_data/v1
+        CLEAN: true
+        GIT_CONFIG_EMAIL: hello@qmk.fm
+        REPOSITORY_NAME: qmk/qmk_keyboards
+        TARGET_FOLDER: v1

.github/workflows/cli.yml

@@ -16,13 +16,13 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
-    container: qmkfm/qmk_cli
+    container: qmkfm/base_container
 
     steps:
     - uses: actions/checkout@v2
       with:
         submodules: recursive
     - name: Install dependencies
-      run: pip3 install -r requirements-dev.txt
+      run: pip3 install -r requirements.txt
     - name: Run tests
-      run: qmk pytest
+      run: bin/qmk pytest

.github/workflows/develop_api.yml

@@ -7,12 +7,11 @@ on:
     paths:
     - 'keyboards/**'
     - 'layouts/community/**'
-  workflow_dispatch:
 
 jobs:
   api_data:
     runs-on: ubuntu-latest
-    container: qmkfm/qmk_cli
+    container: qmkfm/base_container
 
     # protect against those who work in their fork on develop
     if: github.repository == 'qmk/qmk_firmware'
@@ -26,13 +25,18 @@ jobs:
     - name: Generate API Data
       run: qmk generate-api
 
+    - name: Install rsync
+      run: |
+        apt-get update && apt-get install -y rsync
+
     - name: Upload API Data
-      uses: jakejarvis/s3-sync-action@master
+      uses: JamesIves/github-pages-deploy-action@3.7.1
       with:
-        args: --acl public-read --follow-symlinks --delete
-      env:
-        AWS_S3_BUCKET: ${{ secrets.API_SPACE_DEVELOP }}
-        AWS_ACCESS_KEY_ID: ${{ secrets.SPACES_ACCESS_KEY }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.SPACES_SECRET_KEY }}
-        AWS_S3_ENDPOINT: https://nyc3.digitaloceanspaces.com
-        SOURCE_DIR: 'api_data'
+        ACCESS_TOKEN: ${{ secrets.API_TOKEN_GITHUB }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        BRANCH: main
+        FOLDER: api_data/v1
+        CLEAN: true
+        GIT_CONFIG_EMAIL: hello@qmk.fm
+        REPOSITORY_NAME: qmk/qmk_keyboards_devel
+        TARGET_FOLDER: v1

.github/workflows/docs.yml

@@ -14,7 +14,7 @@ on:
 jobs:
   generate:
     runs-on: ubuntu-latest
-    container: qmkfm/qmk_cli
+    container: qmkfm/base_container
 
     # protect against those who develop with their fork on master
     if: github.repository == 'qmk/qmk_firmware'

.github/workflows/format.yaml

@@ -1,42 +1,43 @@
-name: PR Lint Format
+name: Format Codebase
 
 on:
-  pull_request:
-    paths:
-    - 'drivers/**'
-    - 'lib/arm_atsam/**'
-    - 'lib/lib8tion/**'
-    - 'lib/python/**'
-    - 'platforms/**'
-    - 'quantum/**'
-    - 'tests/**'
-    - 'tmk_core/**'
+  push:
+    branches:
+    - master
 
 jobs:
-  lint:
+  format:
     runs-on: ubuntu-latest
+    container: qmkfm/base_container
 
-    container: qmkfm/qmk_cli
+    # protect against those who develop with their fork on master
+    if: github.repository == 'qmk/qmk_firmware'
 
     steps:
-    - uses: rlespinasse/github-slug-action@v3.x
-
     - uses: actions/checkout@v2
       with:
-        fetch-depth: 0
+        token: ${{ secrets.API_TOKEN_GITHUB }}
 
-    - uses: trilom/file-changes-action@v1.2.4
-      id: file_changes
-      with:
-        output: ' '
-        fileOutput: ' '
-
-    - name: Run qmk format-c and qmk format-python
-      shell: 'bash {0}'
+    - name: Install dependencies
       run: |
-        qmk format-c --core-only -n $(< ~/files.txt)
-        format_c_exit=$?
-        qmk format-python -n
-        format_python_exit=$?
+        apt-get update && apt-get install -y dos2unix
 
-        exit $((format_c_exit + format_python_exit))
+    - name: Format files
+      run: |
+        bin/qmk cformat -a
+        bin/qmk pyformat
+        bin/qmk fileformat
+
+    - name: Become QMK Bot
+      run: |
+        git config user.name 'QMK Bot'
+        git config user.email 'hello@qmk.fm'
+
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v3
+      with:
+        delete-branch: true
+        author: QMK Bot <hello@qmk.fm>
+        committer: QMK Bot <hello@qmk.fm>
+        commit-message: Format code according to conventions
+        title: '[CI] Format code according to conventions'

.github/workflows/lint.yml

@@ -9,7 +9,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
 
-    container: qmkfm/qmk_cli
+    container: qmkfm/base_container
 
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -1,32 +1,35 @@
-# Junk files
-*.bak
-*.swp
-*~
-.DS_Store
-
-# Build artifacts
-.clang_complete
-.build/
+.history/
+.dep
+*.o
+*.bin
+*.eep
 *.elf
+*.hex
+*.qmk
+!util/bootloader.hex
+!quantum/tools/eeprom_reset.hex
 *.log
 *.lss
 *.lst
 *.map
-*.o
-*.stackdump
 *.sym
-
-# QMK-specific
+*.swp
+tags
+*~
 api_data/v1
-doxygen/
+build/
+.build/
+*.bak
+.vagrant/
 quantum/version.h
-*.bin
-*.eep
-*.hex
-*.qmk
-*.uf2
-
-# Old-style QMK Makefiles
+.idea/
+CMakeLists.txt
+cmake-build-debug
+.clang_complete
+doxygen/
+.DS_Store
+/util/wsl_downloaded
+/util/win_downloaded
 /keyboards/*/Makefile
 /keyboards/*/*/Makefile
 /keyboards/*/*/*/Makefile
@@ -39,49 +42,37 @@ quantum/version.h
 /keyboards/*/*/*/*/*/keymaps/Makefile
 
 # Eclipse/PyCharm/Other IDE Settings
-*.iml
-.browse.VC.db*
 .cproject
-.idea
-.idea/
 .project
 .settings/
-.vagrant/
-
-# ?
-.dep
-.history/
-build/
-cmake-build-debug
-CMakeLists.txt
-
+.idea
+*.iml
+.browse.VC.db*
+*.stackdump
 # Let these ones be user specific, since we have so many different configurations
-*.code-workspace
-.stfolder
-.tags
 .vscode/c_cpp_properties.json
-.vscode/ipch/
-.vscode/last.sql
 .vscode/launch.json
 .vscode/tasks.json
+.vscode/last.sql
 .vscode/temp.sql
-tags
+.vscode/ipch/
+.stfolder
+.tags
 
-# Ignore image files
+# ignore image files
+*.png
 *.gif
 *.jpg
-*.png
 
-# Things Travis sees
-/.vs
-id_rsa_*
+# things travis sees
 secrets.tar
+id_rsa_*
+/.vs
 
-# Python things
+# python things
 __pycache__
-.python-version
 
-# Prerequisites for updating ChibiOS
+# prerequisites for updating ChibiOS
 /util/fmpp*
 
 # Allow to exist but don't include it in the repo

.travis.yml

@@ -0,0 +1,38 @@
+os: linux
+dist: trusty
+group: edge
+language: c
+branches:
+  except:
+    - /^.*-automated-build$/
+    - /^[0-9]+\.[0-9]+\.[0-9]+/
+env:
+  global:
+  - secure: vBTSL34BDPxDilKUuTXqU4CJ26Pv5hogD2nghatkxSQkI1/jbdnLj/DQdPUrMJFDIY6TK3AltsBx72MaMsLQ1JO/Ou24IeHINHXzUC1FlS9yQa48cpxnhX5kzXNyGs3oa0qaFbvnr7RgYRWtmD52n4bIZuSuW+xpBv05x2OCizdT2ZonH33nATaHGFasxROm4qYZ241VfzcUv766V6RVHgL4x9V08warugs+RENVkfzxxwhk3NmkrISabze0gSVJLHBPHxroZC6EUcf/ocobcuDrCwFqtEt90i7pNIAFUE7gZsN2uE75LmpzAWin21G7lLPcPL2k4FJVd8an1HiP2WmscJU6U89fOfMb2viObnKcCzebozBCmKGtHEuXZo9FcReOx49AnQSpmESJGs+q2dL/FApkTjQiyT4J6O5dJpoww0/r57Wx0cmmqjETKBb5rSgXM51Etk3wO09mvcPHsEwrT7qH8r9XWdyCDoEn7FCLX3/LYnf/D4SmZ633YPl5gv3v9XEwxR5+04akjgnvWDSNIaDbWBdxHNb7l4pMc+WR1bwCyMyA7KXj0RrftEGOrm9ZRLe6BkbT4cycA+j77nbPOMcyZChliV9pPQos+4TOJoTzcK2L8yWVoY409aDNVuAjdP6Yum0R2maBGl/etLmIMpJC35C5/lZ+dUNjJAM=
+  - MAKEFLAGS="-j3 --output-sync"
+services:
+  - docker
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+      - llvm-toolchain-trusty-7
+    packages:
+    - diffutils
+    - clang-format-7
+    - libstdc++-7-dev
+script:
+  - git fetch --depth=50 origin $TRAVIS_BRANCH:$TRAVIS_BRANCH
+  - git rev-parse --short HEAD
+  - git diff --name-only HEAD $TRAVIS_BRANCH
+  - bash util/travis_test.sh
+  - bash util/travis_build.sh
+after_script:
+  bash util/travis_compiled_push.sh
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/afce403d65f143dfac09
+    on_success: always  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # options: [always|never|change] default: always

.vscode/settings.json

@@ -22,9 +22,5 @@
     "[markdown]": {
         "editor.trimAutoWhitespace": false,
         "files.trimTrailingWhitespace": false
-    },
-    "python.formatting.provider": "yapf",
-    "[json]": {
-	    "editor.formatOnSave": false
     }
 }

CODE_OF_CONDUCT.md

@@ -0,0 +1,24 @@
+# Code Of Conduct
+
+QMK strives to be an inclusive, tolerant, and welcoming community. We encourage participation from anyone regardless of age, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, political belief, race, religion, or sexual identity and orientation.
+
+> “A gentle word turns away wrath, but a harsh word stirs up anger."
+
+Our users, contributors, and collaborators are expected to treat each other with kindness and respect, to assume good intentions, and to gently correct, where possible, rather than react with escalation. While our goal is to be as accurate as possible, kindness and understanding are more valuable than correctness. Some examples of behavior we will not tolerate include, but is not limited to:
+
+* The use of sexualized language or imagery
+* Unwelcome advances, sexual or otherwise
+* Deliberate intimidation, stalking, or following
+* Insults or derogatory comments, or personal or political attacks
+* Publishing others’ private information without explicit permission
+* Sustained disruption of talks or other events
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+* Advocating for, or encouraging, any of the above behaviour
+
+# Reporting
+
+If someone is violating this Code of Conduct, please email hello@qmk.fm or reach out to one of the Collaborators to bring it to our attention. All complaints will be reviewed and investigated.
+
+QMK will seek to use the least punitive means available to resolve an issue. If the circumstances require asking an offender to leave, we will do that.
+
+Reports will be taken and kept in strict confidence. You will not be required to confront an offender directly.

Dockerfile

@@ -1,6 +1,7 @@
-FROM qmkfm/qmk_cli
+FROM qmkfm/base_container
 
 VOLUME /qmk_firmware
 WORKDIR /qmk_firmware
+COPY . .
 
-CMD qmk compile -kb all -km default
+CMD make all:default

Makefile

@@ -29,13 +29,6 @@ $(info QMK Firmware $(QMK_VERSION))
 endif
 endif
 
-# Determine which qmk cli to use
-ifeq (,$(shell which qmk))
-    QMK_BIN = bin/qmk
-else
-    QMK_BIN = qmk
-endif
-
 # avoid 'Entering|Leaving directory' messages
 MAKEFLAGS += --no-print-directory
 
@@ -93,8 +86,8 @@ clean:
 
 .PHONY: distclean
 distclean: clean
-	echo -n 'Deleting *.bin, *.hex, and *.uf2 ... '
-	rm -f *.bin *.hex *.uf2
+	echo -n 'Deleting *.bin and *.hex ... '
+	rm -f *.bin *.hex
 	echo 'done.'
 
 #Compatibility with the old make variables, anything you specify directly on the command line
@@ -252,20 +245,11 @@ define PARSE_RULE
     else
         $$(info make: *** No rule to make target '$1'. Stop.)
         $$(info |)
-        $$(info | QMK's make format is:)
-        $$(info |     make keyboard_folder:keymap_folder[:target])
-        $$(info |)
-        $$(info | Where `keyboard_folder` is the path to the keyboard relative to)
-        $$(info | `qmk_firmware/keyboards/`, and `keymap_folder` is the name of the)
-        $$(info | keymap folder under that board's `keymaps/` directory.)
-        $$(info |)
-        $$(info | Examples:)
-        $$(info |     keyboards/dz60, keyboards/dz60/keymaps/default)
-        $$(info |       -> make dz60:default)
-        $$(info |       -> qmk compile -kb dz60 -km default)
-        $$(info |     keyboards/planck/rev6, keyboards/planck/keymaps/default)
-        $$(info |       -> make planck/rev6:default:flash)
-        $$(info |       -> qmk flash -kb planck/rev6 -km default)
+        $$(info |  QMK's make format recently changed to use folder locations and colons:)
+        $$(info |     make project_folder:keymap[:target])
+        $$(info |  Examples:)
+        $$(info |     make dz60:default)
+        $$(info |     make planck/rev6:default:flash)
         $$(info |)
     endif
 endef
@@ -400,7 +384,7 @@ define PARSE_KEYMAP
     # Format it in bold
     KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
     # Specify the variables that we are passing forward to submake
-    MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM) REQUIRE_PLATFORM_KEY=$$(REQUIRE_PLATFORM_KEY) QMK_BIN=$$(QMK_BIN)
+    MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM) REQUIRE_PLATFORM_KEY=$$(REQUIRE_PLATFORM_KEY)
     # And the first part of the make command
     MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
     # The message to display
@@ -517,8 +501,8 @@ endef
 %:
 	# Check if we have the CMP tool installed
 	cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
-	# Ensure that $(QMK_BIN) works.
-	if ! $(QMK_BIN) hello 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; exit 1; fi
+	# Ensure that bin/qmk works. This will be a failing check after the next develop merge
+	if ! bin/qmk hello 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; fi
 	# Check if the submodules are dirty, and display a warning if they are
 ifndef SKIP_GIT
 	if [ ! -e lib/chibios ]; then git submodule sync lib/chibios && git submodule update --depth 50 --init lib/chibios; fi
@@ -557,14 +541,29 @@ git-submodule:
 	git submodule sync --recursive
 	git submodule update --init --recursive --progress
 
-# Generate the version.h file
-ifdef SKIP_GIT
-VERSION_H_FLAGS := --skip-git
-endif
 ifdef SKIP_VERSION
-VERSION_H_FLAGS := --skip-all
 SKIP_GIT := yes
 endif
-$(shell $(QMK_BIN) generate-version-h $(VERSION_H_FLAGS) -q -o quantum/version.h)
+
+# Generate the version.h file
+ifndef SKIP_GIT
+    GIT_VERSION := $(shell git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
+    CHIBIOS_VERSION := $(shell cd lib/chibios && git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
+    CHIBIOS_CONTRIB_VERSION := $(shell cd lib/chibios-contrib && git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
+else
+    GIT_VERSION := NA
+    CHIBIOS_VERSION := NA
+    CHIBIOS_CONTRIB_VERSION := NA
+endif
+ifndef SKIP_VERSION
+BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
+else
+BUILD_DATE := 2020-01-01-00:00:00
+endif
+
+$(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h)
+$(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h)
+$(shell echo '#define CHIBIOS_VERSION "$(CHIBIOS_VERSION)"' >> $(ROOT_DIR)/quantum/version.h)
+$(shell echo '#define CHIBIOS_CONTRIB_VERSION "$(CHIBIOS_CONTRIB_VERSION)"' >> $(ROOT_DIR)/quantum/version.h)
 
 include $(ROOT_DIR)/testlist.mk

Vagrantfile

@@ -6,7 +6,7 @@ Vagrant.configure(2) do |config|
   config.vm.define "qmk_firmware"
 
   # VMware/Virtualbox ( and also Hyperv/Parallels) 64 bit
-  config.vm.box = "generic/debian10"
+  config.vm.box = "generic/debian9"
   
   config.vm.synced_folder '.', '/vagrant'
 
@@ -68,13 +68,13 @@ Vagrant.configure(2) do |config|
   ["virtualbox", "vmware_workstation", "vmware_fusion"].each do |type|
     config.vm.provider type do |virt, override|
       override.vm.provision "docker" do |d|
-        d.run "qmkfm/qmk_cli",
+        d.run "qmkfm/base_container",
           cmd: "tail -f /dev/null",
           args: "--privileged -v /dev:/dev -v '/vagrant:/vagrant'"
       end
 
       override.vm.provision "shell", inline: <<-SHELL
-        echo 'docker restart qmkfm-qmk_cli && exec docker exec -it qmkfm-qmk_cli /bin/bash -l' >> ~vagrant/.bashrc
+        echo 'docker restart qmkfm-base_container && exec docker exec -it qmkfm-base_container /bin/bash -l' >> ~vagrant/.bashrc
       SHELL
     end
   end

bin/qmk

@@ -3,6 +3,7 @@
 """
 import os
 import sys
+from importlib.util import find_spec
 from pathlib import Path
 
 # Add the QMK python libs to our path
@@ -11,9 +12,51 @@ qmk_dir = script_dir.parent
 python_lib_dir = Path(qmk_dir / 'lib' / 'python').resolve()
 sys.path.append(str(python_lib_dir))
 
+
+def _check_modules(requirements):
+    """ Check if the modules in the given requirements.txt are available.
+    """
+    with Path(qmk_dir / requirements).open() as fd:
+        for line in fd.readlines():
+            line = line.strip().replace('<', '=').replace('>', '=')
+
+            if len(line) == 0 or line[0] == '#' or line.startswith('-r'):
+                continue
+
+            if '#' in line:
+                line = line.split('#')[0]
+
+            module = dict()
+            module['name'] = module['import'] = line.split('=')[0] if '=' in line else line
+
+            # Not every module is importable by its own name.
+            if module['name'] == "pep8-naming":
+                module['import'] = "pep8ext_naming"
+
+            if not find_spec(module['import']):
+                print('Could not find module %s!' % module['name'])
+                print('Please run `python3 -m pip install -r %s` to install required python dependencies.' % (qmk_dir / requirements,))
+                if developer:
+                    print('You can also turn off developer mode: qmk config user.developer=None')
+                print()
+                exit(255)
+
+
+developer = False
+# Make sure our modules have been setup
+_check_modules('requirements.txt')
+
 # Setup the CLI
 import milc  # noqa
 
+# For developers additional modules are needed
+if milc.cli.config.user.developer:
+    # Do not run the check for 'config',
+    # so users can turn off developer mode
+    if len(sys.argv) == 1 or (len(sys.argv) > 1 and 'config' != sys.argv[1]):
+        developer = True
+        _check_modules('requirements-dev.txt')
+
 milc.EMOJI_LOGLEVELS['INFO'] = '{fg_blue}Ψ{style_reset_all}'
 
 
@@ -29,13 +72,9 @@ def main():
     """
     # Change to the root of our checkout
     os.environ['ORIG_CWD'] = os.getcwd()
-    os.environ['DEPRECATED_BIN_QMK'] = '1'
     os.chdir(qmk_dir)
 
-    print('Warning: The bin/qmk script is being deprecated. Please install the QMK CLI: python3 -m pip install qmk', file=sys.stderr)
-
     # Import the subcommands
-    import milc.subcommand.config  # noqa
     import qmk.cli  # noqa
 
     # Execute

bootloader.mk

@@ -26,7 +26,6 @@
 #     atmel-dfu   Atmel factory DFU
 #     lufa-dfu    LUFA DFU
 #     qmk-dfu     QMK DFU (LUFA + blinkenlight)
-#     qmk-hid     QMK HID (LUFA + blinkenlight)
 #     bootloadHID HIDBootFlash compatible (ATmega32A)
 #     USBasp      USBaspLoader (ATmega328P)
 # ARM:
@@ -41,7 +40,7 @@
 ifeq ($(strip $(BOOTLOADER)), atmel-dfu)
     OPT_DEFS += -DBOOTLOADER_ATMEL_DFU
     OPT_DEFS += -DBOOTLOADER_DFU
-    ifneq (,$(filter $(MCU), at90usb162 atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
+    ifneq (,$(filter $(MCU), atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
         BOOTLOADER_SIZE = 4096
     endif
     ifneq (,$(filter $(MCU), at90usb1286 at90usb1287))
@@ -51,7 +50,7 @@ endif
 ifeq ($(strip $(BOOTLOADER)), lufa-dfu)
     OPT_DEFS += -DBOOTLOADER_LUFA_DFU
     OPT_DEFS += -DBOOTLOADER_DFU
-    ifneq (,$(filter $(MCU), at90usb162 atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
+    ifneq (,$(filter $(MCU), atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
         BOOTLOADER_SIZE = 4096
     endif
     ifneq (,$(filter $(MCU), at90usb1286 at90usb1287))
@@ -61,18 +60,13 @@ endif
 ifeq ($(strip $(BOOTLOADER)), qmk-dfu)
     OPT_DEFS += -DBOOTLOADER_QMK_DFU
     OPT_DEFS += -DBOOTLOADER_DFU
-    ifneq (,$(filter $(MCU), at90usb162 atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
+    ifneq (,$(filter $(MCU), atmega16u2 atmega32u2 atmega16u4 atmega32u4 at90usb646 at90usb647))
         BOOTLOADER_SIZE = 4096
     endif
     ifneq (,$(filter $(MCU), at90usb1286 at90usb1287))
         BOOTLOADER_SIZE = 8192
     endif
 endif
-ifeq ($(strip $(BOOTLOADER)), qmk-hid)
-    OPT_DEFS += -DBOOTLOADER_QMK_HID
-    OPT_DEFS += -DBOOTLOADER_HID
-    BOOTLOADER_SIZE = 4096
-endif
 ifeq ($(strip $(BOOTLOADER)), halfkay)
     OPT_DEFS += -DBOOTLOADER_HALFKAY
     ifeq ($(strip $(MCU)), atmega32u4)
@@ -95,17 +89,11 @@ ifeq ($(strip $(BOOTLOADER)), USBasp)
     BOOTLOADER_SIZE = 4096
 endif
 ifeq ($(strip $(BOOTLOADER)), lufa-ms)
+    # DO NOT USE THIS BOOTLOADER IN NEW PROJECTS!
+    # It is extremely prone to bricking, and is only included to support existing boards.
     OPT_DEFS += -DBOOTLOADER_MS
-    BOOTLOADER_SIZE ?= 8192
+    BOOTLOADER_SIZE = 6144
     FIRMWARE_FORMAT = bin
-cpfirmware: lufa_warning
-.INTERMEDIATE: lufa_warning
-lufa_warning: $(FIRMWARE_FORMAT)
-	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
-	$(info LUFA MASS STORAGE Bootloader selected)
-	$(info DO NOT USE THIS BOOTLOADER IN NEW PROJECTS!)
-	$(info It is extremely prone to bricking, and is only included to support existing boards.)
-	$(info @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@)
 endif
 ifdef BOOTLOADER_SIZE
     OPT_DEFS += -DBOOTLOADER_SIZE=$(strip $(BOOTLOADER_SIZE))
@@ -149,6 +137,3 @@ ifeq ($(strip $(BOOTLOADER)), stm32duino)
     DFU_ARGS = -d 1EAF:0003 -a 2 -R
     DFU_SUFFIX_ARGS = -v 1EAF -p 0003
 endif
-ifeq ($(strip $(BOOTLOADER)), tinyuf2)
-    OPT_DEFS += -DBOOTLOADER_TINYUF2
-endif

build_json.mk

@@ -1,17 +1,31 @@
 # Look for a json keymap file
 ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_5)/keymap.json)","")
+    KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
     KEYMAP_JSON := $(MAIN_KEYMAP_PATH_5)/keymap.json
     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_5)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_4)/keymap.json)","")
+    KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
     KEYMAP_JSON := $(MAIN_KEYMAP_PATH_4)/keymap.json
     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_4)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_3)/keymap.json)","")
+    KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
     KEYMAP_JSON := $(MAIN_KEYMAP_PATH_3)/keymap.json
     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_3)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_2)/keymap.json)","")
+    KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
     KEYMAP_JSON := $(MAIN_KEYMAP_PATH_2)/keymap.json
     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_2)
 else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.json)","")
+    KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
     KEYMAP_JSON := $(MAIN_KEYMAP_PATH_1)/keymap.json
     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
 endif
+
+# Load the keymap-level rules.mk if exists
+ifneq ("$(wildcard $(KEYMAP_PATH))", "")
+    -include $(KEYMAP_PATH)/rules.mk
+endif
+
+# Generate the keymap.c
+$(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
+	bin/qmk json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON)

build_keyboard.mk

@@ -12,9 +12,6 @@ endif
 
 include common.mk
 
-# Set the qmk cli to use
-QMK_BIN ?= qmk
-
 # Set the filename for the final firmware binary
 KEYBOARD_FILESAFE := $(subst /,_,$(KEYBOARD))
 TARGET ?= $(KEYBOARD_FILESAFE)_$(KEYMAP)
@@ -23,15 +20,6 @@ KEYBOARD_OUTPUT := $(BUILD_DIR)/obj_$(KEYBOARD_FILESAFE)
 # Force expansion
 TARGET := $(TARGET)
 
-ifneq ($(FORCE_LAYOUT),)
-    TARGET := $(TARGET)_$(FORCE_LAYOUT)
-endif
-
-# Object files and generated keymap directory
-#     To put object files in current directory, use a dot (.), do NOT make
-#     this an empty or blank macro!
-KEYMAP_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
-
 # For split boards we need to set a master half.
 MASTER ?= left
 ifdef master
@@ -102,16 +90,13 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_1)/rules.mk)","")
     include $(KEYBOARD_PATH_1)/rules.mk
 endif
 
+
 MAIN_KEYMAP_PATH_1 := $(KEYBOARD_PATH_1)/keymaps/$(KEYMAP)
 MAIN_KEYMAP_PATH_2 := $(KEYBOARD_PATH_2)/keymaps/$(KEYMAP)
 MAIN_KEYMAP_PATH_3 := $(KEYBOARD_PATH_3)/keymaps/$(KEYMAP)
 MAIN_KEYMAP_PATH_4 := $(KEYBOARD_PATH_4)/keymaps/$(KEYMAP)
 MAIN_KEYMAP_PATH_5 := $(KEYBOARD_PATH_5)/keymaps/$(KEYMAP)
 
-# Pull in rules from info.json
-INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/info_rules.mk)
-include $(INFO_RULES_MK)
-
 # Check for keymap.json first, so we can regenerate keymap.c
 include build_json.mk
 
@@ -146,35 +131,18 @@ ifeq ("$(wildcard $(KEYMAP_PATH))", "")
     endif
 endif
 
-# Have we found a keymap.json?
-ifneq ("$(wildcard $(KEYMAP_JSON))", "")
-    KEYMAP_C := $(KEYMAP_OUTPUT)/src/keymap.c
-    KEYMAP_H := $(KEYMAP_OUTPUT)/src/config.h
-
-    # Load the keymap-level rules.mk if exists
-    -include $(KEYMAP_PATH)/rules.mk
-
-    # Load any rules.mk content from keymap.json
-    INFO_RULES_MK = $(shell $(QMK_BIN) generate-rules-mk --quiet --escape --keyboard $(KEYBOARD) --keymap $(KEYMAP) --output $(KEYMAP_OUTPUT)/src/rules.mk)
-    include $(INFO_RULES_MK)
-
-# Add rules to generate the keymap files - indentation here is important
-$(KEYMAP_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
-	$(QMK_BIN) json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON)
-
-$(KEYMAP_OUTPUT)/src/config.h: $(KEYMAP_JSON)
-	$(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --keymap $(KEYMAP) --output $(KEYMAP_H)
-
-generated-files: $(KEYMAP_OUTPUT)/src/config.h $(KEYMAP_OUTPUT)/src/keymap.c
-
-endif
-
 ifeq ($(strip $(CTPC)), yes)
   CONVERT_TO_PROTON_C=yes
 endif
 
 ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
-    include platforms/chibios/boards/QMK_PROTON_C/convert_to_proton_c.mk
+    TARGET := $(TARGET)_proton_c
+    include platforms/chibios/GENERIC_STM32_F303XC/configs/proton_c.mk
+    OPT_DEFS += -DCONVERT_TO_PROTON_C
+endif
+
+ifneq ($(FORCE_LAYOUT),)
+    TARGET := $(TARGET)_$(FORCE_LAYOUT)
 endif
 
 include quantum/mcu_selection.mk
@@ -236,7 +204,6 @@ endif
 #
 #    https://docs.qmk.fm/#/feature_layouts?id=tips-for-making-layouts-keyboard-agnostic
 #
-QMK_KEYBOARD_H = $(KEYBOARD_OUTPUT)/src/default_keyboard.h
 ifneq ("$(wildcard $(KEYBOARD_PATH_1)/$(KEYBOARD_FOLDER_1).h)","")
     QMK_KEYBOARD_H = $(KEYBOARD_FOLDER_1).h
 endif
@@ -260,7 +227,6 @@ ifdef MCU_FAMILY
     PLATFORM=CHIBIOS
     PLATFORM_KEY=chibios
     FIRMWARE_FORMAT?=bin
-    OPT_DEFS += -DMCU_$(MCU_FAMILY)
 else ifdef ARM_ATSAM
     PLATFORM=ARM_ATSAM
     PLATFORM_KEY=arm_atsam
@@ -306,39 +272,6 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
     POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
 endif
 
-# Pull in stuff from info.json
-INFO_JSON_FILES :=
-ifneq ("$(wildcard $(KEYBOARD_PATH_1)/info.json)","")
-    INFO_JSON_FILES += $(KEYBOARD_PATH_1)/info.json
-endif
-ifneq ("$(wildcard $(KEYBOARD_PATH_2)/info.json)","")
-    INFO_JSON_FILES += $(KEYBOARD_PATH_2)/info.json
-endif
-ifneq ("$(wildcard $(KEYBOARD_PATH_3)/info.json)","")
-    INFO_JSON_FILES += $(KEYBOARD_PATH_3)/info.json
-endif
-ifneq ("$(wildcard $(KEYBOARD_PATH_4)/info.json)","")
-    INFO_JSON_FILES += $(KEYBOARD_PATH_4)/info.json
-endif
-ifneq ("$(wildcard $(KEYBOARD_PATH_5)/info.json)","")
-    INFO_JSON_FILES += $(KEYBOARD_PATH_5)/info.json
-endif
-
-CONFIG_H += $(KEYBOARD_OUTPUT)/src/info_config.h $(KEYBOARD_OUTPUT)/src/layouts.h
-
-$(KEYBOARD_OUTPUT)/src/info_config.h: $(INFO_JSON_FILES)
-	$(QMK_BIN) generate-config-h --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/info_config.h
-
-$(KEYBOARD_OUTPUT)/src/default_keyboard.h: $(INFO_JSON_FILES)
-	$(QMK_BIN) generate-keyboard-h --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/default_keyboard.h
-
-$(KEYBOARD_OUTPUT)/src/layouts.h: $(INFO_JSON_FILES)
-	$(QMK_BIN) generate-layouts --quiet --keyboard $(KEYBOARD) --output $(KEYBOARD_OUTPUT)/src/layouts.h
-
-generated-files: $(KEYBOARD_OUTPUT)/src/info_config.h $(KEYBOARD_OUTPUT)/src/default_keyboard.h $(KEYBOARD_OUTPUT)/src/layouts.h
-
-.INTERMEDIATE : generated-files
-
 # Userspace setup and definitions
 ifeq ("$(USER_NAME)","")
     USER_NAME := $(KEYMAP)
@@ -349,26 +282,23 @@ USER_PATH := users/$(USER_NAME)
 ifneq ("$(wildcard $(USER_PATH)/config.h)","")
     CONFIG_H += $(USER_PATH)/config.h
 endif
-ifneq ("$(wildcard $(USER_PATH)/post_config.h)","")
-    POST_CONFIG_H += $(USER_PATH)/post_config.h
-endif
 
 # Disable features that a keyboard doesn't support
 -include disable_features.mk
 
+# Object files directory
+#     To put object files in current directory, use a dot (.), do NOT make
+#     this an empty or blank macro!
+KEYMAP_OUTPUT := $(BUILD_DIR)/obj_$(TARGET)
+
 ifneq ("$(wildcard $(KEYMAP_PATH)/config.h)","")
     CONFIG_H += $(KEYMAP_PATH)/config.h
 endif
-ifneq ("$(KEYMAP_H)","")
-    CONFIG_H += $(KEYMAP_H)
-endif
 
 # project specific files
-SRC += \
-    $(KEYBOARD_SRC) \
+SRC += $(KEYBOARD_SRC) \
     $(KEYMAP_C) \
-    $(QUANTUM_SRC) \
-    $(QUANTUM_DIR)/main.c \
+    $(QUANTUM_SRC)
 
 # Optimize size but this may cause error "relocation truncated to fit"
 #EXTRALDFLAGS = -Wl,--relax
@@ -403,7 +333,6 @@ ifneq ($(strip $(PROTOCOL)),)
 else
     include $(TMK_PATH)/protocol/$(PLATFORM_KEY).mk
 endif
--include $(TOP_DIR)/platforms/$(PLATFORM_KEY)/flash.mk
 
 # TODO: remove this bodge?
 PROJECT_DEFS := $(OPT_DEFS)
@@ -422,7 +351,7 @@ ALL_CONFIGS := $(PROJECT_CONFIG) $(CONFIG_H)
 OUTPUTS := $(KEYMAP_OUTPUT) $(KEYBOARD_OUTPUT)
 $(KEYMAP_OUTPUT)_SRC := $(SRC)
 $(KEYMAP_OUTPUT)_DEFS := $(OPT_DEFS) $(GFXDEFS) \
--DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(QMK_KEYBOARD_H)\" \
+-DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYBOARD_H=\"$(QMK_KEYBOARD_H)\" -DQMK_KEYBOARD_CONFIG_H=\"$(KEYBOARD_PATH_1)/config.h\" \
 -DQMK_KEYMAP=\"$(KEYMAP)\" -DQMK_KEYMAP_H=\"$(KEYMAP).h\" -DQMK_KEYMAP_CONFIG_H=\"$(KEYMAP_PATH)/config.h\" \
 -DQMK_SUBPROJECT -DQMK_SUBPROJECT_H -DQMK_SUBPROJECT_CONFIG_H
 $(KEYMAP_OUTPUT)_INC :=  $(VPATH) $(EXTRAINCDIRS)
@@ -447,9 +376,3 @@ objs-size: build
 
 include show_options.mk
 include $(TMK_PATH)/rules.mk
-
-# Ensure we have generated files available for each of the objects
-define GEN_FILES
-$1: generated-files
-endef
-$(foreach O,$(OBJ),$(eval $(call GEN_FILES,$(patsubst %.a,%.o,$(O)))))

build_layout.mk

@@ -7,6 +7,7 @@ define SEARCH_LAYOUTS_REPO
     LAYOUT_KEYMAP_C := $$(LAYOUT_KEYMAP_PATH)/keymap.c
     ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_JSON))","")
         -include $$(LAYOUT_KEYMAP_PATH)/rules.mk
+        KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
         KEYMAP_JSON := $$(LAYOUT_KEYMAP_JSON)
         KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
     else ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_C))","")
@@ -30,3 +31,6 @@ ifneq ($(FORCE_LAYOUT),)
 endif
 
 $(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))
+
+# Use rule from build_json.mk, but update prerequisite in case KEYMAP_JSON was updated
+$(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)

build_test.mk

@@ -24,6 +24,7 @@ GTEST_INTERNAL_INC :=\
 
 $(GTEST_OUTPUT)_SRC :=\
 	googletest/src/gtest-all.cc\
+	googletest/src/gtest_main.cc\
 	googlemock/src/gmock-all.cc
 
 $(GTEST_OUTPUT)_DEFS :=
@@ -34,8 +35,7 @@ CREATE_MAP := no
 
 VPATH +=\
 	$(LIB_PATH)/googletest\
-	$(LIB_PATH)/googlemock\
-	$(LIB_PATH)/printf
+	$(LIB_PATH)/googlemock
 
 all: elf
 
@@ -43,29 +43,18 @@ VPATH += $(COMMON_VPATH)
 PLATFORM:=TEST
 PLATFORM_KEY:=test
 
-ifeq ($(strip $(DEBUG)), 1)
-CONSOLE_ENABLE = yes
-endif
-
 ifneq ($(filter $(FULL_TESTS),$(TEST)),)
 include tests/$(TEST)/rules.mk
 endif
 
 include common_features.mk
 include $(TMK_PATH)/common.mk
-include $(QUANTUM_PATH)/debounce/tests/rules.mk
 include $(QUANTUM_PATH)/sequencer/tests/rules.mk
 include $(QUANTUM_PATH)/serial_link/tests/rules.mk
-include $(TMK_PATH)/common/test/rules.mk
 ifneq ($(filter $(FULL_TESTS),$(TEST)),)
 include build_full_test.mk
 endif
 
-$(TEST)_SRC += \
-	tests/test_common/main.c \
-	$(LIB_PATH)/printf/printf.c \
-	$(QUANTUM_PATH)/logging/print.c
-
 $(TEST_OBJ)/$(TEST)_SRC := $($(TEST)_SRC)
 $(TEST_OBJ)/$(TEST)_INC := $($(TEST)_INC) $(VPATH) $(GTEST_INC)
 $(TEST_OBJ)/$(TEST)_DEFS := $($(TEST)_DEFS)

common.mk

@@ -12,9 +12,6 @@ QUANTUM_PATH = $(QUANTUM_DIR)
 DRIVER_DIR = drivers
 DRIVER_PATH = $(DRIVER_DIR)
 
-PLATFORM_DIR = platforms
-PLATFORM_PATH = $(PLATFORM_DIR)
-
 BUILD_DIR := .build
 
 COMMON_VPATH := $(TOP_DIR)

common_features.mk

@@ -17,25 +17,14 @@ SERIAL_PATH := $(QUANTUM_PATH)/serial_link
 
 QUANTUM_SRC += \
     $(QUANTUM_DIR)/quantum.c \
-    $(QUANTUM_DIR)/send_string.c \
     $(QUANTUM_DIR)/bitwise.c \
     $(QUANTUM_DIR)/led.c \
-    $(QUANTUM_DIR)/action.c \
-    $(QUANTUM_DIR)/action_layer.c \
-    $(QUANTUM_DIR)/action_macro.c \
-    $(QUANTUM_DIR)/action_tapping.c \
-    $(QUANTUM_DIR)/action_util.c \
-    $(QUANTUM_DIR)/eeconfig.c \
-    $(QUANTUM_DIR)/keyboard.c \
     $(QUANTUM_DIR)/keymap_common.c \
-    $(QUANTUM_DIR)/keycode_config.c \
-    $(QUANTUM_DIR)/logging/debug.c \
-    $(QUANTUM_DIR)/logging/sendchar.c \
+    $(QUANTUM_DIR)/keycode_config.c
 
-VPATH += $(QUANTUM_DIR)/logging
-# Fall back to lib/printf if there is no platform provided print
-ifeq ("$(wildcard $(TMK_PATH)/common/$(PLATFORM_KEY)/printf.mk)","")
-    include $(QUANTUM_PATH)/logging/print.mk
+KEYBOARD_ENABLE ?= yes
+ifeq ($(strip $(KEYBOARD_ENABLE)), yes)
+    OPT_DEFS += -DKEYBOARD_ENABLE
 endif
 
 ifeq ($(strip $(DEBUG_MATRIX_SCAN_RATE_ENABLE)), yes)
@@ -58,31 +47,12 @@ ifeq ($(strip $(COMMAND_ENABLE)), yes)
     OPT_DEFS += -DCOMMAND_ENABLE
 endif
 
-AUDIO_ENABLE ?= no
 ifeq ($(strip $(AUDIO_ENABLE)), yes)
-    ifeq ($(PLATFORM),CHIBIOS)
-        AUDIO_DRIVER ?= dac_basic
-        ifeq ($(strip $(AUDIO_DRIVER)), dac_basic)
-            OPT_DEFS += -DAUDIO_DRIVER_DAC
-        else ifeq ($(strip $(AUDIO_DRIVER)), dac_additive)
-            OPT_DEFS += -DAUDIO_DRIVER_DAC
-        ## stm32f2 and above have a usable DAC unit, f1 do not, and need to use pwm instead
-        else ifeq ($(strip $(AUDIO_DRIVER)), pwm_software)
-            OPT_DEFS += -DAUDIO_DRIVER_PWM
-        else ifeq ($(strip $(AUDIO_DRIVER)), pwm_hardware)
-            OPT_DEFS += -DAUDIO_DRIVER_PWM
-        endif
-    else
-        # fallback for all other platforms is pwm
-        AUDIO_DRIVER ?= pwm_hardware
-        OPT_DEFS += -DAUDIO_DRIVER_PWM
-    endif
     OPT_DEFS += -DAUDIO_ENABLE
     MUSIC_ENABLE = yes
     SRC += $(QUANTUM_DIR)/process_keycode/process_audio.c
     SRC += $(QUANTUM_DIR)/process_keycode/process_clicky.c
-    SRC += $(QUANTUM_DIR)/audio/audio.c ## common audio code, hardware agnostic
-    SRC += $(QUANTUM_DIR)/audio/driver_$(PLATFORM_KEY)_$(strip $(AUDIO_DRIVER)).c
+    SRC += $(QUANTUM_DIR)/audio/audio_$(PLATFORM_KEY).c
     SRC += $(QUANTUM_DIR)/audio/voices.c
     SRC += $(QUANTUM_DIR)/audio/luts.c
 endif
@@ -115,15 +85,14 @@ ifeq ($(strip $(VIRTSER_ENABLE)), yes)
     OPT_DEFS += -DVIRTSER_ENABLE
 endif
 
-ifeq ($(strip $(MOUSEKEY_ENABLE)), yes)
-    OPT_DEFS += -DMOUSEKEY_ENABLE
-    MOUSE_ENABLE := yes
-    SRC += $(QUANTUM_DIR)/mousekey.c
+ifeq ($(strip $(FAUXCLICKY_ENABLE)), yes)
+    OPT_DEFS += -DFAUXCLICKY_ENABLE
+    SRC += $(QUANTUM_DIR)/fauxclicky.c
 endif
 
 ifeq ($(strip $(POINTING_DEVICE_ENABLE)), yes)
     OPT_DEFS += -DPOINTING_DEVICE_ENABLE
-    MOUSE_ENABLE := yes
+    OPT_DEFS += -DMOUSE_ENABLE
     SRC += $(QUANTUM_DIR)/pointing_device.c
 endif
 
@@ -177,7 +146,7 @@ else
         # This ensures that the EEPROM page buffer fits into RAM
         USE_PROCESS_STACKSIZE = 0x600
         USE_EXCEPTIONS_STACKSIZE = 0x300
-
+        
         SRC += $(PLATFORM_COMMON_DIR)/eeprom_stm32.c
         SRC += $(PLATFORM_COMMON_DIR)/flash_stm32.c
         OPT_DEFS += -DEEPROM_EMU_STM32F042x6
@@ -185,7 +154,6 @@ else
       else ifneq ($(filter $(MCU_SERIES),STM32L0xx STM32L1xx),)
         OPT_DEFS += -DEEPROM_DRIVER
         COMMON_VPATH += $(DRIVER_PATH)/eeprom
-        COMMON_VPATH += $(PLATFORM_PATH)/$(PLATFORM_KEY)/$(DRIVER_DIR)/eeprom
         SRC += eeprom_driver.c eeprom_stm32_L0_L1.c
       else
         # This will effectively work the same as "transient" if not supported by the chip
@@ -199,124 +167,86 @@ else
   endif
 endif
 
-RGBLIGHT_ENABLE ?= no
-VALID_RGBLIGHT_TYPES := WS2812 APA102 custom
-
-ifeq ($(strip $(RGBLIGHT_CUSTOM_DRIVER)), yes)
-    RGBLIGHT_DRIVER ?= custom
-endif
-
 ifeq ($(strip $(RGBLIGHT_ENABLE)), yes)
-    RGBLIGHT_DRIVER ?= WS2812
-
-    ifeq ($(filter $(RGBLIGHT_DRIVER),$(VALID_RGBLIGHT_TYPES)),)
-        $(error RGBLIGHT_DRIVER="$(RGBLIGHT_DRIVER)" is not a valid RGB type)
+    POST_CONFIG_H += $(QUANTUM_DIR)/rgblight_post_config.h
+    OPT_DEFS += -DRGBLIGHT_ENABLE
+    SRC += $(QUANTUM_DIR)/color.c
+    SRC += $(QUANTUM_DIR)/rgblight.c
+    CIE1931_CURVE := yes
+    RGB_KEYCODES_ENABLE := yes
+    ifeq ($(strip $(RGBLIGHT_CUSTOM_DRIVER)), yes)
+        OPT_DEFS += -DRGBLIGHT_CUSTOM_DRIVER
     else
-        COMMON_VPATH += $(QUANTUM_DIR)/rgblight
-        POST_CONFIG_H += $(QUANTUM_DIR)/rgblight/rgblight_post_config.h
-        OPT_DEFS += -DRGBLIGHT_ENABLE
-        SRC += $(QUANTUM_DIR)/color.c
-        SRC += $(QUANTUM_DIR)/rgblight/rgblight.c
-        CIE1931_CURVE := yes
-        RGB_KEYCODES_ENABLE := yes
-    endif
-
-    ifeq ($(strip $(RGBLIGHT_DRIVER)), WS2812)
         WS2812_DRIVER_REQUIRED := yes
     endif
-
-    ifeq ($(strip $(RGBLIGHT_DRIVER)), APA102)
-        APA102_DRIVER_REQUIRED := yes
-    endif
-
-    ifeq ($(strip $(RGBLIGHT_DRIVER)), custom)
-        OPT_DEFS += -DRGBLIGHT_CUSTOM_DRIVER
-    endif
 endif
 
+
 LED_MATRIX_ENABLE ?= no
 VALID_LED_MATRIX_TYPES := IS31FL3731 custom
 # TODO: IS31FL3733 IS31FL3737 IS31FL3741
 
 ifeq ($(strip $(LED_MATRIX_ENABLE)), yes)
     ifeq ($(filter $(LED_MATRIX_DRIVER),$(VALID_LED_MATRIX_TYPES)),)
-        $(error "$(LED_MATRIX_DRIVER)" is not a valid matrix type)
+        $(error LED_MATRIX_DRIVER="$(LED_MATRIX_DRIVER)" is not a valid matrix type)
+    else
+        BACKLIGHT_ENABLE = yes
+        BACKLIGHT_DRIVER = custom
+        OPT_DEFS += -DLED_MATRIX_ENABLE
+        SRC += $(QUANTUM_DIR)/led_matrix.c
+        SRC += $(QUANTUM_DIR)/led_matrix_drivers.c
     endif
-    OPT_DEFS += -DLED_MATRIX_ENABLE
-ifneq (,$(filter $(MCU), atmega16u2 atmega32u2 at90usb162))
-    # ATmegaxxU2 does not have hardware MUL instruction - lib8tion must be told to use software multiplication routines
-    OPT_DEFS += -DLIB8_ATTINY
-endif
-    COMMON_VPATH += $(QUANTUM_DIR)/led_matrix
-    COMMON_VPATH += $(QUANTUM_DIR)/led_matrix/animations
-    COMMON_VPATH += $(QUANTUM_DIR)/led_matrix/animations/runners
-    SRC += $(QUANTUM_DIR)/process_keycode/process_backlight.c
-    SRC += $(QUANTUM_DIR)/led_matrix/led_matrix.c
-    SRC += $(QUANTUM_DIR)/led_matrix/led_matrix_drivers.c
-    SRC += $(LIB_PATH)/lib8tion/lib8tion.c
-    CIE1931_CURVE := yes
 
     ifeq ($(strip $(LED_MATRIX_DRIVER)), IS31FL3731)
         OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-        COMMON_VPATH += $(DRIVER_PATH)/led/issi
+        COMMON_VPATH += $(DRIVER_PATH)/issi
         SRC += is31fl3731-simple.c
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 endif
 
 RGB_MATRIX_ENABLE ?= no
-VALID_RGB_MATRIX_TYPES := AW20216 IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 custom
+VALID_RGB_MATRIX_TYPES := IS31FL3731 IS31FL3733 IS31FL3737 IS31FL3741 WS2812 custom
 
 ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
     ifeq ($(filter $(RGB_MATRIX_DRIVER),$(VALID_RGB_MATRIX_TYPES)),)
         $(error "$(RGB_MATRIX_DRIVER)" is not a valid matrix type)
     endif
     OPT_DEFS += -DRGB_MATRIX_ENABLE
-ifneq (,$(filter $(MCU), atmega16u2 atmega32u2 at90usb162))
+ifneq (,$(filter $(MCU), atmega16u2 atmega32u2))
     # ATmegaxxU2 does not have hardware MUL instruction - lib8tion must be told to use software multiplication routines
     OPT_DEFS += -DLIB8_ATTINY
 endif
-    COMMON_VPATH += $(QUANTUM_DIR)/rgb_matrix
-    COMMON_VPATH += $(QUANTUM_DIR)/rgb_matrix/animations
-    COMMON_VPATH += $(QUANTUM_DIR)/rgb_matrix/animations/runners
     SRC += $(QUANTUM_DIR)/color.c
-    SRC += $(QUANTUM_DIR)/rgb_matrix/rgb_matrix.c
-    SRC += $(QUANTUM_DIR)/rgb_matrix/rgb_matrix_drivers.c
-    SRC += $(LIB_PATH)/lib8tion/lib8tion.c
+    SRC += $(QUANTUM_DIR)/rgb_matrix.c
+    SRC += $(QUANTUM_DIR)/rgb_matrix_drivers.c
     CIE1931_CURVE := yes
     RGB_KEYCODES_ENABLE := yes
 
-    ifeq ($(strip $(RGB_MATRIX_DRIVER)), AW20216)
-        OPT_DEFS += -DAW20216 -DSTM32_SPI -DHAL_USE_SPI=TRUE
-        COMMON_VPATH += $(DRIVER_PATH)/led
-        SRC += aw20216.c
-        QUANTUM_LIB_SRC += spi_master.c
-    endif
-
     ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3731)
         OPT_DEFS += -DIS31FL3731 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-        COMMON_VPATH += $(DRIVER_PATH)/led/issi
+        COMMON_VPATH += $(DRIVER_PATH)/issi
         SRC += is31fl3731.c
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 
     ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3733)
         OPT_DEFS += -DIS31FL3733 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-        COMMON_VPATH += $(DRIVER_PATH)/led/issi
+        COMMON_VPATH += $(DRIVER_PATH)/issi
         SRC += is31fl3733.c
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 
     ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3737)
         OPT_DEFS += -DIS31FL3737 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-        COMMON_VPATH += $(DRIVER_PATH)/led/issi
+        COMMON_VPATH += $(DRIVER_PATH)/issi
         SRC += is31fl3737.c
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 
     ifeq ($(strip $(RGB_MATRIX_DRIVER)), IS31FL3741)
         OPT_DEFS += -DIS31FL3741 -DSTM32_I2C -DHAL_USE_I2C=TRUE
-        COMMON_VPATH += $(DRIVER_PATH)/led/issi
+        COMMON_VPATH += $(DRIVER_PATH)/issi
         SRC += is31fl3741.c
         QUANTUM_LIB_SRC += i2c_master.c
     endif
@@ -326,11 +256,6 @@ endif
         WS2812_DRIVER_REQUIRED := yes
     endif
 
-    ifeq ($(strip $(RGB_MATRIX_DRIVER)), APA102)
-        OPT_DEFS += -DAPA102
-        APA102_DRIVER_REQUIRED := yes
-    endif
-
     ifeq ($(strip $(RGB_MATRIX_CUSTOM_KB)), yes)
         OPT_DEFS += -DRGB_MATRIX_CUSTOM_KB
     endif
@@ -374,14 +299,15 @@ ifeq ($(strip $(LCD_ENABLE)), yes)
     CIE1931_CURVE := yes
 endif
 
+# backward compat
+ifeq ($(strip $(BACKLIGHT_CUSTOM_DRIVER)), yes)
+    BACKLIGHT_DRIVER := custom
+endif
+
 VALID_BACKLIGHT_TYPES := pwm timer software custom
 
 BACKLIGHT_ENABLE ?= no
-ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
-    BACKLIGHT_DRIVER ?= software
-else
-    BACKLIGHT_DRIVER ?= pwm
-endif
+BACKLIGHT_DRIVER ?= pwm
 ifeq ($(strip $(BACKLIGHT_ENABLE)), yes)
     ifeq ($(filter $(BACKLIGHT_DRIVER),$(VALID_BACKLIGHT_TYPES)),)
         $(error BACKLIGHT_DRIVER="$(BACKLIGHT_DRIVER)" is not a valid backlight type)
@@ -432,11 +358,6 @@ ifeq ($(strip $(WS2812_DRIVER_REQUIRED)), yes)
     endif
 endif
 
-ifeq ($(strip $(APA102_DRIVER_REQUIRED)), yes)
-    COMMON_VPATH += $(DRIVER_PATH)/led
-    SRC += apa102.c
-endif
-
 ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
     CIE1931_CURVE := yes
 endif
@@ -456,6 +377,10 @@ ifeq ($(strip $(TERMINAL_ENABLE)), yes)
     OPT_DEFS += -DUSER_PRINT
 endif
 
+ifeq ($(strip $(USB_HID_ENABLE)), yes)
+    include $(TMK_DIR)/protocol/usb_hid.mk
+endif
+
 ifeq ($(strip $(WPM_ENABLE)), yes)
     SRC += $(QUANTUM_DIR)/wpm.c
     OPT_DEFS += -DWPM_ENABLE
@@ -489,20 +414,6 @@ ifeq ($(strip $(DIP_SWITCH_ENABLE)), yes)
     SRC += $(QUANTUM_DIR)/dip_switch.c
 endif
 
-VALID_MAGIC_TYPES := yes lite
-BOOTMAGIC_ENABLE ?= no
-ifneq ($(strip $(BOOTMAGIC_ENABLE)), no)
-  ifeq ($(filter $(BOOTMAGIC_ENABLE),$(VALID_MAGIC_TYPES)),)
-    $(error BOOTMAGIC_ENABLE="$(BOOTMAGIC_ENABLE)" is not a valid type of magic)
-  endif
-  ifneq ($(strip $(BOOTMAGIC_ENABLE)), no)
-      OPT_DEFS += -DBOOTMAGIC_LITE
-      QUANTUM_SRC += $(QUANTUM_DIR)/bootmagic/bootmagic_lite.c
-  endif
-endif
-COMMON_VPATH += $(QUANTUM_DIR)/bootmagic
-QUANTUM_SRC += $(QUANTUM_DIR)/bootmagic/magic.c
-
 VALID_CUSTOM_MATRIX_TYPES:= yes lite no
 
 CUSTOM_MATRIX ?= no
@@ -518,31 +429,42 @@ ifneq ($(strip $(CUSTOM_MATRIX)), yes)
     # if 'lite' then skip the actual matrix implementation
     ifneq ($(strip $(CUSTOM_MATRIX)), lite)
         # Include the standard or split matrix code if needed
-        QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
+        ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
+            QUANTUM_SRC += $(QUANTUM_DIR)/split_common/matrix.c
+        else
+            QUANTUM_SRC += $(QUANTUM_DIR)/matrix.c
+        endif
     endif
 endif
 
+# Support for translating old names to new names:
+ifeq ($(strip $(DEBOUNCE_TYPE)),sym_g)
+    DEBOUNCE_TYPE:=sym_defer_g
+else ifeq ($(strip $(DEBOUNCE_TYPE)),eager_pk)
+    DEBOUNCE_TYPE:=sym_eager_pk
+else ifeq ($(strip $(DEBOUNCE_TYPE)),sym_pk)
+    DEBOUNCE_TYPE:=sym_defer_pk
+else ifeq ($(strip $(DEBOUNCE_TYPE)),eager_pr)
+    DEBOUNCE_TYPE:=sym_eager_pr
+endif
+
+DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
 # Debounce Modules. Set DEBOUNCE_TYPE=custom if including one manually.
-DEBOUNCE_TYPE ?= sym_defer_g
+DEBOUNCE_TYPE?= sym_defer_g
 ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
-    QUANTUM_SRC += $(QUANTUM_DIR)/debounce/$(strip $(DEBOUNCE_TYPE)).c
+    QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
 endif
 
 ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
     POST_CONFIG_H += $(QUANTUM_DIR)/split_common/post_config.h
     OPT_DEFS += -DSPLIT_KEYBOARD
-    CRC_ENABLE := yes
 
     # Include files used by all split keyboards
     QUANTUM_SRC += $(QUANTUM_DIR)/split_common/split_util.c
 
     # Determine which (if any) transport files are required
     ifneq ($(strip $(SPLIT_TRANSPORT)), custom)
-        QUANTUM_SRC += $(QUANTUM_DIR)/split_common/transport.c \
-                       $(QUANTUM_DIR)/split_common/transactions.c
-
-        OPT_DEFS += -DSPLIT_COMMON_TRANSACTIONS
-
+        QUANTUM_SRC += $(QUANTUM_DIR)/split_common/transport.c
         # Functions added via QUANTUM_LIB_SRC are only included in the final binary if they're called.
         # Unused functions are pruned away, which is why we can add multiple drivers here without bloat.
         ifeq ($(PLATFORM),AVR)
@@ -563,17 +485,11 @@ ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
     COMMON_VPATH += $(QUANTUM_PATH)/split_common
 endif
 
-ifeq ($(strip $(CRC_ENABLE)), yes)
-    OPT_DEFS += -DCRC_ENABLE
-    SRC += crc.c
-endif
-
 HAPTIC_ENABLE ?= no
 ifneq ($(strip $(HAPTIC_ENABLE)),no)
     COMMON_VPATH += $(DRIVER_PATH)/haptic
+    SRC += haptic.c
     OPT_DEFS += -DHAPTIC_ENABLE
-    SRC += $(QUANTUM_DIR)/haptic.c
-    SRC += $(QUANTUM_DIR)/process_keycode/process_haptic.c
 endif
 
 ifneq ($(filter DRV2605L, $(HAPTIC_ENABLE)), )
@@ -588,33 +504,15 @@ ifneq ($(filter SOLENOID, $(HAPTIC_ENABLE)), )
 endif
 
 ifeq ($(strip $(HD44780_ENABLE)), yes)
-    SRC += platforms/avr/drivers/hd44780.c
+    SRC += drivers/avr/hd44780.c
     OPT_DEFS += -DHD44780_ENABLE
 endif
 
-VALID_OLED_DRIVER_TYPES := SSD1306 custom
-OLED_DRIVER ?= SSD1306
-ifeq ($(strip $(OLED_ENABLE)), yes)
-    ifeq ($(filter $(OLED_DRIVER),$(VALID_OLED_DRIVER_TYPES)),)
-        $(error OLED_DRIVER="$(OLED_DRIVER)" is not a valid OLED driver)
-    else
-        OPT_DEFS += -DOLED_ENABLE
-        COMMON_VPATH += $(DRIVER_PATH)/oled
-
-        OPT_DEFS += -DOLED_DRIVER_$(strip $(shell echo $(OLED_DRIVER) | tr '[:lower:]' '[:upper:]'))
-        ifeq ($(strip $(OLED_DRIVER)), SSD1306)
-            SRC += ssd1306_sh1106.c
-            QUANTUM_LIB_SRC += i2c_master.c
-        endif
-    endif
-endif
-
-ifeq ($(strip $(ST7565_ENABLE)), yes)
-    OPT_DEFS += -DST7565_ENABLE
-    COMMON_VPATH += $(DRIVER_PATH)/oled # For glcdfont.h
-    COMMON_VPATH += $(DRIVER_PATH)/lcd
-    QUANTUM_LIB_SRC += spi_master.c
-    SRC += st7565.c
+ifeq ($(strip $(OLED_DRIVER_ENABLE)), yes)
+    OPT_DEFS += -DOLED_DRIVER_ENABLE
+    COMMON_VPATH += $(DRIVER_PATH)/oled
+    QUANTUM_LIB_SRC += i2c_master.c
+    SRC += oled_driver.c
 endif
 
 include $(DRIVER_PATH)/qwiic/qwiic.mk
@@ -669,11 +567,6 @@ ifeq ($(strip $(COMBO_ENABLE)), yes)
     OPT_DEFS += -DCOMBO_ENABLE
 endif
 
-ifeq ($(strip $(KEY_OVERRIDE_ENABLE)), yes)
-    SRC += $(QUANTUM_DIR)/process_keycode/process_key_override.c
-    OPT_DEFS += -DKEY_OVERRIDE_ENABLE
-endif
-
 ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
     SRC += $(QUANTUM_DIR)/process_keycode/process_tap_dance.c
     OPT_DEFS += -DTAP_DANCE_ENABLE
@@ -713,31 +606,7 @@ ifeq ($(strip $(JOYSTICK_ENABLE)), digital)
     OPT_DEFS += -DDIGITAL_JOYSTICK_ENABLE
 endif
 
-DIGITIZER_ENABLE ?= no
-ifneq ($(strip $(DIGITIZER_ENABLE)), no)
-    SRC += $(QUANTUM_DIR)/digitizer.c
-endif
-
-USBPD_ENABLE ?= no
-VALID_USBPD_DRIVER_TYPES = custom vendor
-USBPD_DRIVER ?= vendor
-ifeq ($(strip $(USBPD_ENABLE)), yes)
-    ifeq ($(filter $(strip $(USBPD_DRIVER)),$(VALID_USBPD_DRIVER_TYPES)),)
-        $(error USBPD_DRIVER="$(USBPD_DRIVER)" is not a valid USBPD driver)
-    else
-        OPT_DEFS += -DUSBPD_ENABLE
-        ifeq ($(strip $(USBPD_DRIVER)), vendor)
-            # Vendor-specific implementations
-            OPT_DEFS += -DUSBPD_VENDOR
-            ifeq ($(strip $(MCU_SERIES)), STM32G4xx)
-                OPT_DEFS += -DUSBPD_STM32G4
-                SRC += usbpd_stm32g4.c
-            else
-                $(error There is no vendor-provided USBPD driver available)
-            endif
-        else ifeq ($(strip $(USBPD_DRIVER)), custom)
-            OPT_DEFS += -DUSBPD_CUSTOM
-            # Board designers can add their own driver to $(SRC)
-        endif
-    endif
-endif
+ifeq ($(strip $(SWITCH_CONTROLLER_ENABLE)), yes)
+    OPT_DEFS += -DSWITCH_CONTROLLER_ENABLE
+    OPT_DEFS += -DGAMEPAD_ENABLE
+endif

data/mappings/info_config.json

@@ -1,96 +0,0 @@
-# This file maps keys between `config.h` and `info.json`. It is used by QMK
-# to correctly and consistently map back and forth between the two systems.
-{
-    # Format:
-    # <config.h key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
-    # value_type: one of "array", "array.int", "bool", "int", "hex", "list", "mapping"
-    # to_json: Default `true`. Set to `false` to exclude this mapping from info.json
-    # to_c: Default `true`. Set to `false` to exclude this mapping from config.h
-    # warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
-    "AUDIO_VOICES": {"info_key": "audio.voices", "value_type": "bool"},
-    "BACKLIGHT_BREATHING": {"info_key": "backlight.breathing", "value_type": "bool"},
-    "BREATHING_PERIOD": {"info_key": "backlight.breathing_period", "value_type": "int"},
-    "BACKLIGHT_PIN": {"info_key": "backlight.pin"},
-    "COMBO_COUNT": {"info_key": "combo.count", "value_type": "int"},
-    "COMBO_TERM": {"info_key": "combo.term", "value_type": "int"},
-    "DEBOUNCE": {"info_key": "debounce", "value_type": "int"},
-    "DEVICE_VER": {"info_key": "usb.device_ver", "value_type": "hex"},
-    "DESCRIPTION": {"info_key": "keyboard_folder", "to_json": false},
-    "DIODE_DIRECTION": {"info_key": "diode_direction"},
-    "FORCE_NKRO": {"info_key": "usb.force_nkro", "value_type": "bool"},
-    "DYNAMIC_KEYMAP_EEPROM_MAX_ADDR": {"info_key": "dynamic_keymap.eeprom_max_addr", "value_type": "int"},
-    "DYNAMIC_KEYMAP_LAYER_COUNT": {"info_key": "dynamic_keymap.layer_count", "value_type": "int"},
-    "IGNORE_MOD_TAP_INTERRUPT": {"info_key": "tapping.ignore_mod_tap_interrupt", "value_type": "bool"},
-    "IGNORE_MOD_TAP_INTERRUPT_PER_KEY": {"info_key": "tapping.ignore_mod_tap_interrupt_per_key", "value_type": "bool"},
-    "LAYOUTS": {"info_key": "layout_aliases", "value_type": "mapping"},
-    "LEADER_PER_KEY_TIMING": {"info_key": "leader_key.timing", "value_type": "bool"},
-    "LEADER_KEY_STRICT_KEY_PROCESSING": {"info_key": "leader_key.strict_processing", "value_type": "bool"},
-    "LEADER_TIMEOUT": {"info_key": "leader_key.timeout", "value_type": "int"},
-    "LED_CAPS_LOCK_PIN": {"info_key": "indicators.caps_lock"},
-    "LED_NUM_LOCK_PIN": {"info_key": "indicators.num_lock"},
-    "LED_SCROLL_LOCK_PIN": {"info_key": "indicators.scroll_lock"},
-    "MANUFACTURER": {"info_key": "manufacturer"},
-    "MATRIX_HAS_GHOST": {"info_key": "matrix_pins.ghost", "value_type": "bool"},
-    "MATRIX_IO_DELAY": {"info_key": "matrix_pins.io_delay", "value_type": "int"},
-    "MOUSEKEY_DELAY": {"info_key": "mousekey.delay", "value_type": "int"},
-    "MOUSEKEY_INTERVAL": {"info_key": "mousekey.interval", "value_type": "int"},
-    "MOUSEKEY_MAX_SPEED": {"info_key": "mousekey.max_speed", "value_type": "int"},
-    "MOUSEKEY_TIME_TO_MAX": {"info_key": "mousekey.time_to_max", "value_type": "int"},
-    "MOUSEKEY_WHEEL_DELAY": {"info_key": "mousekey.wheel_delay", "value_type": "int"},
-    "ONESHOT_TIMEOUT": {"info_key": "oneshot.timeout", "value_type": "int"},
-    "ONESHOT_TAP_TOGGLE": {"info_key": "oneshot.tap_toggle", "value_type": "int"},
-    "PERMISSIVE_HOLD": {"info_key": "tapping.permissive_hold", "value_type": "bool"},
-    "PERMISSIVE_HOLD_PER_KEY": {"info_key": "tapping.permissive_hold_per_key", "value_type": "bool"},
-    "RETRO_TAPPING": {"info_key": "tapping.retro", "value_type": "bool"},
-    "RETRO_TAPPING_PER_KEY": {"info_key": "tapping.retro_per_key", "value_type": "bool"},
-    "RGB_DI_PIN": {"info_key": "rgblight.pin"},
-    "RGBLED_NUM": {"info_key": "rgblight.led_count", "value_type": "int"},
-    "RGBLED_SPLIT": {"info_key": "rgblight.split_count", "value_type": "array.int"},
-    "RGBLIGHT_ANIMATIONS": {"info_key": "rgblight.animations.all", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_ALTERNATING": {"info_key": "rgblight.animations.alternating", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_BREATHING": {"info_key": "rgblight.animations.breathing", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_CHRISTMAS": {"info_key": "rgblight.animations.christmas", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_KNIGHT": {"info_key": "rgblight.animations.knight", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_RAINBOW_MOOD": {"info_key": "rgblight.animations.rainbow_mood", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_RAINBOW_SWIRL": {"info_key": "rgblight.animations.rainbow_swirl", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_RGB_TEST": {"info_key": "rgblight.animations.rgb_test", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_SNAKE": {"info_key": "rgblight.animations.snake", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_STATIC_GRADIENT": {"info_key": "rgblight.animations.static_gradient", "value_type": "bool"},
-    "RGBLIGHT_EFFECT_TWINKLE": {"info_key": "rgblight.animations.twinkle"},
-    "RGBLIGHT_LAYER_BLINK": {"info_key": "rgblight.layers.blink", "value_type": "bool"},
-    "RGBLIGHT_LAYERS": {"info_key": "rgblight.layers.enabled", "value_type": "bool"},
-    "RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF": {"info_key": "rgblight.layers.override_rgb", "value_type": "bool"},
-    "RGBLIGHT_LIMIT_VAL": {"info_key": "rgblight.max_brightness", "value_type": "int"},
-    "RGBLIGHT_MAX_LAYERS": {"info_key": "rgblight.layers.max", "value_type": "int"},
-    "RGBLIGHT_HUE_STEP": {"info_key": "rgblight.hue_steps", "value_type": "int"},
-    "RGBLIGHT_SAT_STEP": {"info_key": "rgblight.saturation_steps", "value_type": "int"},
-    "RGBLIGHT_VAL_STEP": {"info_key": "rgblight.brightness_steps", "value_type": "int"},
-    "RGBLIGHT_SLEEP": {"info_key": "rgblight.sleep", "value_type": "bool"},
-    "RGBLIGHT_SPLIT": {"info_key": "rgblight.split", "value_type": "bool"},
-    "RGBW": {"info_key": "rgblight.rgbw", "value_type": "bool"},
-    "PRODUCT": {"info_key": "keyboard_folder", "to_json": false},
-    "PRODUCT_ID": {"info_key": "usb.pid", "value_type": "hex"},
-    "VENDOR_ID": {"info_key": "usb.vid", "value_type": "hex"},
-    "QMK_ESC_OUTPUT": {"info_key": "qmk_lufa_bootloader.esc_output"},
-    "QMK_ESC_INPUT": {"info_key": "qmk_lufa_bootloader.esc_input"},
-    "QMK_KEYS_PER_SCAN": {"info_key": "qmk.keys_per_scan", "value_type": "int"},
-    "QMK_LED": {"info_key": "qmk_lufa_bootloader.led"},
-    "QMK_SPEAKER": {"info_key": "qmk_lufa_bootloader.speaker"},
-    "SPLIT_MODS_ENABLE": {"info_key": "split.transport.sync_modifiers", "value_type": "bool"},
-    "SPLIT_TRANSPORT_MIRROR": {"info_key": "split.transport.sync_matrix_state", "value_type": "bool"},
-    "SPLIT_USB_DETECT": {"info_key": "split.usb_detect.enabled", "value_type": "bool"},
-    "SPLIT_USB_TIMEOUT": {"info_key": "split.usb_detect.timeout", "value_type": "int"},
-    "SPLIT_USB_TIMEOUT_POLL": {"info_key": "split.usb_detect.polling_interval", "value_type": "int"},
-    "SOFT_SERIAL_PIN": {"info_key": "split.soft_serial_pin"},
-    "SOFT_SERIAL_SPEED": {"info_key": "split.soft_serial_speed"},
-    "TAP_CODE_DELAY": {"info_key": "qmk.tap_keycode_delay", "value_type": "int"},
-    "TAP_HOLD_CAPS_DELAY": {"info_key": "qmk.tap_capslock_delay", "value_type": "int"},
-    "TAPPING_FORCE_HOLD": {"info_key": "tapping.force_hold", "value_type": "bool"},
-    "TAPPING_FORCE_HOLD_PER_KEY": {"info_key": "tapping.force_hold_per_key", "value_type": "bool"},
-    "TAPPING_TERM": {"info_key": "tapping.term", "value_type": "int"},
-    "TAPPING_TERM_PER_KEY": {"info_key": "tapping.term_per_key", "value_type": "bool"},
-    "TAPPING_TOGGLE": {"info_key": "tapping.toggle", "value_type": "int"},
-    "USB_MAX_POWER_CONSUMPTION": {"info_key": "usb.max_power", "value_type": "int"},
-    "USB_POLLING_INTERVAL_MS": {"info_key": "usb.polling_interval", "value_type": "int"},
-    "USB_SUSPEND_WAKEUP_DELAY": {"info_key": "usb.suspend_wakeup_delay", "value_type": "int"},
-}

data/mappings/info_rules.json

@@ -1,25 +0,0 @@
-# This file maps keys between `rules.mk` and `info.json`. It is used by QMK
-# to correctly and consistently map back and forth between the two systems.
-{
-    # Format:
-    # <rules.mk key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
-    # value_type: one of "array", "array.int", "bool", "int", "list", "hex", "mapping"
-    # to_json: Default `true`. Set to `false` to exclude this mapping from info.json
-    # to_c: Default `true`. Set to `false` to exclude this mapping from rules.mk
-    # warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
-    "BOARD": {"info_key": "board"},
-    "BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
-    "BLUETOOTH": {"info_key": "bluetooth.driver"},
-    "FIRMWARE_FORMAT": {"info_key": "build.firmware_format"},
-    "KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"},
-    "MOUSE_SHARED_EP": {"info_key": "usb.shared_endpoint.mouse", "value_type": "bool"},
-    "LAYOUTS": {"info_key": "community_layouts", "value_type": "list"},
-    "LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"},
-    "LTO_ENABLE": {"info_key": "build.lto", "value_type": "bool"},
-    "MCU": {"info_key": "processor", "warn_duplicate": false},
-    "MOUSEKEY_ENABLE": {"info_key": "mouse_key.enabled", "value_type": "bool"},
-    "NO_USB_STARTUP_CHECK": {"info_key": "usb.no_startup_check", "value_type": "bool"},
-    "SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"},
-    "SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "value_type": "str", "to_c": false},
-    "WAIT_FOR_USB": {"info_key": "usb.wait_for", "value_type": "bool"}
-}

data/mappings/keyboard_aliases.json

@@ -1,564 +0,0 @@
-{
-    # Format for each entry:
-    # <alias>: {
-    #     target: <keyboard_folder>,
-    #     layouts: {
-    #         <layout_alias>: <layout_target>
-    #     }
-    # }
-    #
-    # Both target and layouts are optional.
-    '2_milk': {
-          target: 'spaceman/2_milk'
-    },
-    'aeboards/constellation': {
-          target: 'aeboards/constellation/rev1'
-    },
-    'aeboards/ext65': {
-          target: 'aeboards/ext65/rev1'
-    },
-    'ai03/equinox': {
-          target: 'ai03/equinox/rev1'
-    },
-    aleth42: {
-          target: 'aleth42/rev1'
-    },
-    alice: {
-          target: 'tgr/alice'
-    },
-    angel17: {
-          target: 'angel17/alpha'
-    },
-    angel64: {
-          target: 'angel64/alpha'
-    },
-    at101_blackheart: {
-          target: 'at101_bh'
-    },
-    'atom47/rev2': {
-          target: 'maartenwut/atom47/rev2'
-    },
-    'atom47/rev3': {
-          target: 'maartenwut/atom47/rev3'
-    },
-    bakeneko65: {
-          target: 'bakeneko65/rev2'
-    },
-    bear_face: {
-          target: 'bear_face/v1'
-    },
-    bm16a: {
-          target: 'kprepublic/bm16a'
-    },
-    bm16s: {
-          target: 'kprepublic/bm16s'
-    },
-    bm40hsrgb: {
-          target: 'kprepublic/bm40hsrgb'
-    },
-    bm43a: {
-          target: 'kprepublic/bm43a'
-    },
-    bm60poker: {
-          target: 'kprepublic/bm60poker'
-    },
-    bm60rgb: {
-          target: 'kprepublic/bm60rgb'
-    },
-    bm60rgb_iso: {
-          target: 'kprepublic/bm60rgb_iso'
-    },
-    bm68rgb: {
-          target: 'kprepublic/bm68rgb'
-    },
-    'bpiphany/pegasushoof': {
-          target: 'bpiphany/pegasushoof/2013'
-    },
-    chavdai40: {
-          target: 'chavdai40/rev1'
-    },
-    'candybar/lefty': {
-          target: 'tkc/candybar/lefty'
-    },
-    'candybar/righty': {
-          target: 'tkc/candybar/righty'
-    },
-    canoe: {
-          target: 'percent/canoe'
-    },
-    'clawsome/gamebuddy': {
-          target: 'clawsome/gamebuddy/v1_0'
-    },
-    'cmm_studio/saka68': {
-          target: 'cmm_studio/saka68/solder'
-    },
-    'cospad': {
-          target: 'kprepublic/cospad'
-    },
-    'crkbd/rev1/legacy': {
-          target: 'crkbd/rev1'
-    },
-    'crkbd/rev1/common': {
-          target: 'crkbd/rev1'
-    },
-    'custommk/genesis': {
-          target: 'custommk/genesis/rev1'
-    },
-    'daisy': {
-          target: 'ktec/daisy'
-    },
-    'doro67/multi': {
-          layouts: {
-                  LAYOUT_ansi: 'LAYOUT_65_ansi_blocker'
-          }
-    },
-    'doro67/regular': {
-          layouts: {
-                  LAYOUT: 'LAYOUT_65_ansi_blocker'
-          }
-    },
-    'doro67/rgb': {
-          layouts: {
-                  LAYOUT: 'LAYOUT_65_ansi_blocker'
-          }
-    },
-    drakon: {
-          target: 'jagdpietr/drakon'
-    },
-    'durgod/k320': {
-          target: 'durgod/k3x0/k320'
-    },
-    'dztech/dz60rgb': {
-          target: 'dztech/dz60rgb/v1'
-    },
-    'dztech/dz60rgb_ansi': {
-          target: 'dztech/dz60rgb_ansi/v1'
-    },
-    'dztech/dz60rgb_wkl': {
-          target: 'dztech/dz60rgb_wkl/v1'
-    },
-    'dztech/dz65rgb': {
-          target: 'dztech/dz65rgb/v1'
-    },
-    'dztech/volcano660': {
-          target: 'ilumkb/volcano660'
-    },
-    eek: {
-          target: 'eek/silk_down'
-    },
-    'ergodone': {
-          target: 'ktec/ergodone'
-    },
-    ergoinu: {
-          target: 'dm9records/ergoinu'
-    },
-    'exclusive/e85': {
-          target: 'exclusive/e85/hotswap'
-    },
-    gh60: {
-          target: 'gh60/revc'
-    },
-    'gmmk/pro': {
-          target: 'gmmk/pro/ansi'
-    },
-    'handwired/ferris': {
-          target: 'ferris/0_1'
-    },
-    'handwired/p1800fl': {
-          target: 'team0110/p1800fl'
-    },
-    'helix/pico/sc/back': {
-          target: 'helix/pico/sc'
-    },
-    'helix/pico/sc/under': {
-          target: 'helix/pico/sc'
-    },
-    'helix/rev2/back/oled': {
-          target: 'helix/rev2/back'
-    },
-    'helix/rev2/oled': {
-          target: 'helix/rev2'
-    },
-    'helix/rev2/oled/back': {
-          target: 'helix/rev2/back'
-    },
-    'helix/rev2/oled/under': {
-          target: 'helix/rev2/under'
-    },
-    'helix/rev2/sc/back': {
-          target: 'helix/rev2/sc'
-    },
-    'helix/rev2/sc/oled': {
-          target: 'helix/rev2/sc'
-    },
-    'helix/rev2/sc/oledback': {
-          target: 'helix/rev2/sc'
-    },
-    'helix/rev2/sc/oledunder': {
-          target: 'helix/rev2/sc'
-    },
-    'helix/rev2/sc/under': {
-          target: 'helix/rev2/sc'
-    },
-    'helix/rev2/under': {
-          target: 'helix/rev2/sc'
-    },
-    'helix/rev2/under/oled': {
-          target: 'helix/rev2/under'
-    },
-    id80: {
-          target: 'id80/ansi'
-    },
-    idb_60: {
-          target: 'idb/idb_60',
-          layouts: {
-                  LAYOUT: 'LAYOUT_all'
-          }
-    },
-    'jj40': {
-          target: 'kprepublic/jj40'
-    },
-    'jj4x4': {
-          target: 'kprepublic/jj4x4'
-    },
-    'jj50': {
-          target: 'kprepublic/jj50'
-    },
-    jones: {
-          target: 'jones/v03_1'
-    },
-    katana60: {
-          target: 'rominronin/katana60/rev1'
-    },
-    'kbdfans/kbd67mkiirgb': {
-          target: 'kbdfans/kbd67/mkiirgb',
-          layouts: {
-                  LAYOUT: 'LAYOUT_65_ansi_blocker'
-          }
-    },
-    'kbdfans/kbd67/mkiirgb': {
-          target: 'kbdfans/kbd67/mkiirgb/v1'
-    },
-    'keebio/dsp40': {
-          target: 'keebio/dsp40/rev1'
-    },
-    'keycapsss/plaid_pad': {
-          target: 'keycapsss/plaid_pad/rev1'
-    },
-    kudox: {
-          target: 'kudox/rev1'
-    },
-    'kyria': {
-          target: 'splitkb/kyria'
-    },
-    'lazydesigners/the60': {
-          target: 'lazydesigners/the60/rev1'
-    },
-    'lfkeyboards/lfk78': {
-          target: 'lfkeyboards/lfk78/revj'
-    },
-    'lfkeyboards/smk65': {
-          target: 'lfkeyboards/smk65/revb'
-    },
-    'maartenwut/atom47/rev2': {
-          target: 'evyd13/atom47/rev2'
-    },
-    'maartenwut/atom47/rev3': {
-          target: 'evyd13/atom47/rev3'
-    },
-    'maartenwut/eon40': {
-          target: 'evyd13/eon40'
-    },
-    'maartenwut/eon65': {
-          target: 'evyd13/eon65'
-    },
-    'maartenwut/eon75': {
-          target: 'evyd13/eon75'
-    },
-    'maartenwut/eon87': {
-          target: 'evyd13/eon87'
-    },
-    'maartenwut/eon95': {
-          target: 'evyd13/eon95'
-    },
-    'maartenwut/gh80_1800': {
-          target: 'evyd13/gh80_1800'
-    },
-    'maartenwut/gh80_3700': {
-          target: 'evyd13/gh80_3700'
-    },
-    'maartenwut/minitomic': {
-          target: 'evyd13/minitomic'
-    },
-    'maartenwut/mx5160': {
-          target: 'evyd13/mx5160'
-    },
-    'maartenwut/nt660': {
-          target: 'evyd13/nt660'
-    },
-    'maartenwut/omrontkl': {
-          target: 'evyd13/omrontkl'
-    },
-    'maartenwut/plain60': {
-          target: 'evyd13/plain60'
-    },
-    'maartenwut/pockettype': {
-          target: 'evyd13/pockettype'
-    },
-    'maartenwut/quackfire': {
-          target: 'evyd13/quackfire'
-    },
-    'maartenwut/solheim68': {
-          target: 'evyd13/solheim68'
-    },
-    'maartenwut/ta65': {
-          target: 'evyd13/ta65'
-    },
-    'maartenwut/wasdat': {
-          target: 'evyd13/wasdat'
-    },
-    'maartenwut/wasdat_code': {
-          target: 'evyd13/wasdat_code'
-    },
-    'maartenwut/wonderland': {
-          target: 'evyd13/wonderland'
-    },
-    'matrix/m12og': {
-          target: 'matrix/m12og/rev1'
-    },
-    'mechlovin/hannah910': {
-          target: 'mechlovin/hannah910/rev1'
-    },
-    'mechlovin/adelais/rgb_led': {
-          target: 'mechlovin/adelais/rgb_led/rev1'
-    },
-    'mechlovin/adelais/standard_led': {
-          target: 'mechlovin/adelais/standard_led/rev2'
-    },
-    'mechlovin/delphine': {
-          target: 'mechlovin/delphine/mono_led'
-    },
-    'mechlovin/hannah60rgb': {
-          target: 'mechlovin/hannah60rgb/rev1'
-    },
-    'mechlovin/hannah65/mechlovin9': {
-          target: 'mechlovin/mechlovin9/rev1'
-    },
-    'melgeek/z70ultra': {
-          target: 'melgeek/z70ultra/rev1'
-    },
-    'mechlovin/hannah65': {
-          target: 'mechlovin/hannah65/rev1'
-    },
-    model01: {
-          target: 'keyboardio/model01'
-    },
-    m0lly: {
-          target: 'tkc/m0lly'
-    },
-    'montsinger/rebound': {
-          target: 'montsinger/rebound/rev1'
-    },
-    nomu30: {
-          target: 'nomu30/rev1'
-    },
-    'noxary/268_2': {
-          layouts: {
-                  LAYOUT: 'LAYOUT_65_ansi_blocker'
-          }
-    },
-    oddball: {
-          target: 'oddball/v1'
-    },
-    omnikey_blackheart: {
-          target: 'omnikey_bh'
-    },
-    'pabile/p20': {
-          target: 'pabile/p20/ver1'
-    },
-    'pancake/feather': {
-          target: 'spaceman/pancake/feather'
-    },
-    'pancake/promicro': {
-          target: 'spaceman/pancake/promicro'
-    },
-    'peiorisboards/ixora': {
-          target: 'coarse/ixora'
-    },
-    'percent/canoe': {
-          layouts: {
-                  LAYOUT_iso: 'LAYOUT_65_iso_blocker'
-          }
-    },
-    plaid: {
-          target: 'dm9records/plaid'
-    },
-    plain60: {
-          target: 'maartenwut/plain60'
-    },
-    'ploopyco/trackball': {
-          target: 'ploopyco/trackball/rev1_005'
-    },
-    polilla: {
-          target: 'polilla/rev1'
-    },
-    'preonic/rev1': {
-          layouts: {
-                  LAYOUT_preonic_grid: 'LAYOUT_ortho_5x12'
-          }
-    },
-    'preonic/rev2': {
-          layouts: {
-                  LAYOUT_preonic_grid: 'LAYOUT_ortho_5x12'
-          }
-    },
-    'preonic/rev3': {
-          layouts: {
-                  LAYOUT_preonic_grid: 'LAYOUT_ortho_5x12'
-          }
-    },
-    'primekb/prime_l': {
-          target: 'primekb/prime_l/v1'
-    },
-    'primekb/prime_l_v2': {
-          target: 'primekb/prime_l/v2'
-    },
-    'projectkb/alice': {
-          target: 'projectkb/alice/rev1'
-    },
-    'rama/koyu': {
-          target: 'wilba_tech/rama_works_koyu'
-    },
-    'rama/m6_a': {
-          target: 'wilba_tech/rama_works_m6_a'
-    },
-    'rama/m6_b': {
-          target: 'wilba_tech/rama_works_m6_b'
-    },
-    'rama/m10_b': {
-          target: 'wilba_tech/rama_works_m10_b'
-    },
-    'rama/m60_a': {
-          target: 'wilba_tech/rama_works_m60_a'
-    },
-    'rama/u80_a': {
-          target: 'wilba_tech/rama_works_u80_a'
-    },
-    'ramonimbao/herringbone': {
-          target: 'ramonimbao/herringbone/v1'
-    },
-    'ramonimbao/mona': {
-          target: 'ramonimbao/mona/v1'
-    },
-    'rgbkb/pan': {
-          target: 'rgbkb/pan/rev1/32a'
-    },
-    'rgbkb/pan/rev1': {
-          target: 'rgbkb/pan/rev1/32a'
-    },
-    romac: {
-          target: 'kingly_keys/romac'
-    },
-    ropro: {
-          target: 'kingly_keys/ropro'
-    },
-    satan: {
-          target: 'gh60/satan'
-    },
-    skog: {
-          target: 'percent/skog'
-    },
-    speedo: {
-          target: 'cozykeys/speedo/v2'
-    },
-    'staryu': {
-          target: 'ktec/staryu'
-    },
-    stoutgat: {
-          target: 'tkw/stoutgat/v1'
-    },
-    suihankey: {
-          target: 'suihankey/split/alpha'
-    },
-    ta65: {
-          target: 'maartenwut/ta65'
-    },
-    tartan: {
-          target: 'dm9records/tartan'
-    },
-    tkc1800: {
-          target: 'tkc/tkc1800'
-    },
-    'tkw/stoutgat/v2': {
-          target: 'tkw/stoutgat/v2/f411'
-    },
-    'tokyo60': {
-          target: 'tokyokeyboard/tokyo60'
-    },
-    underscore33: {
-          target: 'underscore33/rev1'
-    },
-    vinta: {
-          target: 'coarse/vinta',
-          layouts: {
-                  LAYOUT_67_ansi: 'LAYOUT_65_ansi_blocker'
-          }
-    },
-    wasdat: {
-          target: 'maartenwut/wasdat'
-    },
-    'westfoxtrot/cypher': {
-          target: 'westfoxtrot/cypher/rev1'
-    },
-    'whale/sk': {
-          target: 'whale/sk/v3'
-    },
-    'xd002': {
-          target: 'xiudi/xd002'
-    },
-    'xd004': {
-          target: 'xiudi/xd004'
-    },
-    'xd60': {
-          target: 'xiudi/xd60'
-    },
-    'xd68': {
-          target: 'xiudi/xd68'
-    },
-    'xd75': {
-          target: 'xiudi/xd75'
-    },
-    'xd84': {
-          target: 'xiudi/xd84'
-    },
-    'xd84pro': {
-          target: 'xiudi/xd84pro'
-    },
-    'xd87': {
-          target: 'xiudi/xd87'
-    },
-    'xd96': {
-          target: 'xiudi/xd96'
-    },
-    'xelus/dawn60': {
-          target: 'xelus/dawn60/rev1'
-    },
-    'xelus/valor': {
-          target: 'xelus/valor/rev1'
-    },
-    yd60mq: {
-          target: 'yd60mq/12led'
-    },
-    ymd75: {
-          target: 'ymd75/rev1'
-    },
-    z150_blackheart: {
-          target: 'z150_bh'
-    },
-    zeal60: {
-          target: 'wilba_tech/zeal60'
-    },
-    zeal65: {
-          target: 'wilba_tech/zeal65'
-    }
-}

data/schemas/api_keyboard.jsonschema

@@ -1,23 +0,0 @@
-{
-    "$id": "qmk.api.keyboard.v1",
-    "allOf": [
-        {"$ref": "qmk.keyboard.v1"},
-        {
-            "properties": {
-                "keymaps": {
-                    "type": "object",
-                    "properties": {
-                        "url": {"type": "string"}
-                    }
-
-                },
-                "parse_errors": {"$ref": "qmk.definitions.v1#/string_array"},
-                "parse_warnings": {"$ref": "qmk.definitions.v1#/string_array"},
-                "processor_type": {"type": "string"},
-                "protocol": {"type": "string"},
-                "keyboard_folder": {"type": "string"},
-                "platform": {"type": "string"}
-            }
-        }
-    ]
-}

data/schemas/definitions.jsonschema

@@ -1,107 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "qmk.definitions.v1",
-    "title": "Common definitions used across QMK's jsonschemas.",
-    "type": "object",
-    "boolean_array": {
-        "type": "object",
-        "additionalProperties": {"type": "boolean"}
-    },
-    "filename": {
-        "type": "string",
-        "minLength": 1,
-        "pattern": "^[0-9a-z_]*$"
-    },
-    "hex_number_2d": {
-        "type": "string",
-        "pattern": "^0x[0-9A-F]{2}$"
-    },
-    "hex_number_4d": {
-        "type": "string",
-        "pattern": "^0x[0-9A-F]{4}$"
-    },
-    "text_identifier": {
-        "type": "string",
-        "minLength": 1,
-        "maxLength": 250
-    },
-    "layout_macro": {
-        "oneOf": [
-            {
-                "type": "string",
-                "enum": ["LAYOUT", "LAYOUT_planck_1x2uC"]
-            },
-            {
-                "type": "string",
-                "pattern": "^LAYOUT_[0-9a-z_]*$"
-            }
-        ]
-    },
-    "key_unit": {
-        "type": "number",
-        "min": 0.25
-    },
-    "mcu_pin_array": {
-        "type": "array",
-        "items": {"$ref": "#/mcu_pin"}
-    },
-    "mcu_pin": {
-        "oneOf": [
-            {
-                "type": "string",
-                "pattern": "^[A-K]\\d{1,2}$"
-            },
-            {
-                "type": "string",
-                "pattern": "^LINE_PIN\\d{1,2}$"
-            },
-            {
-                "type": "number",
-                "multipleOf": 1
-            },
-            {
-                "type": "null"
-            }
-        ]
-    },
-    "signed_decimal": {
-        "type": "number"
-    },
-    "signed_int": {
-        "type": "number",
-        "multipleOf": 1
-    }
-    "signed_int_8": {
-        "type": "number",
-        "min": -127,
-        "max": 127,
-        "multipleOf": 1
-    }
-    "string_array": {
-        "type": "array",
-        "items": {
-            "type": "string"
-        }
-    },
-    "string_object": {
-        "type": "object",
-        "additionalProperties": {
-            "type": "string"
-        }
-    },
-    "unsigned_decimal": {
-        "type": "number",
-        "min": 0
-    },
-    "unsigned_int": {
-        "type": "number",
-        "min": 0,
-        "multipleOf": 1
-    }
-    "unsigned_int_8": {
-        "type": "number",
-        "min": 0,
-        "max": 255,
-        "multipleOf": 1
-    }
-}

data/schemas/false.jsonschema

@@ -1 +0,0 @@
-false

data/schemas/keyboard.jsonschema

@@ -1,363 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "qmk.keyboard.v1",
-    "title": "Keyboard Information",
-    "type": "object",
-    "properties": {
-        "keyboard_name": {"$ref": "qmk.definitions.v1#/text_identifier"},
-        "maintainer": {"$ref": "qmk.definitions.v1#/text_identifier"},
-        "manufacturer": {"$ref": "qmk.definitions.v1#/text_identifier"},
-        "url": {
-            "type": "string",
-            "format": "uri"
-        },
-        "processor": {
-            "type": "string",
-            "enum": ["cortex-m0", "cortex-m0plus", "cortex-m3", "cortex-m4", "MKL26Z64", "MK20DX128", "MK20DX256", "MK66F18", "STM32F042", "STM32F072", "STM32F103", "STM32F303", "STM32F401", "STM32F407", "STM32F411", "STM32F446", "STM32G431", "STM32G474", "STM32L412", "STM32L422", "STM32L433", "STM32L443", "atmega16u2", "atmega32u2", "atmega16u4", "atmega32u4", "at90usb162", "at90usb646", "at90usb647", "at90usb1286", "at90usb1287", "atmega32a", "atmega328p", "atmega328", "attiny85", "unknown"]
-        },
-        "audio": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "pins": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
-                "voices": {"type": "boolean"}
-            }
-        },
-        "backlight": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "breathing": {"type": "boolean"},
-                "breathing_period": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "levels": {
-                    "type": "number",
-                    "min": 1,
-                    "max": 31,
-                    "multipleOf": 1
-                },
-                "pin": {"$ref": "qmk.definitions.v1#/mcu_pin"}
-            }
-        },
-        "bluetooth": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "driver": {
-                    "type": "string",
-                    "enum": ["AdafruitBLE", "RN42"]
-                },
-                "lto": {"type": "boolean"},
-            }
-        },
-        "board": {
-            "type": "string",
-            "minLength": 2,
-            "pattern": "^[a-zA-Z_][0-9a-zA-Z_]*$"
-        },
-        "bootloader": {
-            "type": "string",
-            "enum": ["atmel-dfu", "bootloadHID", "caterina", "halfkay", "kiibohd", "lufa-dfu", "lufa-ms", "micronucleus", "qmk-dfu", "qmk-hid", "stm32-dfu", "stm32duino", "unknown", "USBasp", "tinyuf2"],
-        },
-        "bootloader_instructions": {
-            "type": "string",
-            "description": "Instructions for putting the keyboard into a mode that allows for firmware flashing."
-        },
-        "build": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "debounce_type": {
-                    "type": "string",
-                    "enum": ["custom", "eager_pk", "eager_pr", "sym_defer_pk", "sym_eager_pk"]
-                },
-                "firmware_format": {
-                    "type": "string",
-                    "enum": ["bin", "hex", "uf2"]
-                },
-                "lto": {"type": "boolean"},
-            }
-        },
-        "diode_direction": {
-            "type": "string",
-            "enum": ["COL2ROW", "ROW2COL"]
-        },
-        "debounce": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-        "combo": {
-            "type": "object",
-            "properties": {
-                "count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "term": {"$ref": "qmk.definitions.v1#/unsigned_int"}
-            }
-        },
-        "community_layouts": {
-            "type": "array",
-            "items": {"$ref": "qmk.definitions.v1#/filename"}
-        },
-        "features": {"$ref": "qmk.definitions.v1#/boolean_array"},
-        "indicators": {
-            "type": "object",
-            "properties": {
-                "caps_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "num_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "scroll_lock": {"$ref": "qmk.definitions.v1#/mcu_pin"}
-            }
-        },
-        "layout_aliases": {
-            "type": "object",
-            "additionalProperties": {"$ref": "qmk.definitions.v1#/layout_macro"}
-        },
-        "layouts": {
-            "type": "object",
-            "additionalProperties": {
-                "type": "object",
-                "additionalProperties": false,
-                "properties": {
-                    "filename": {
-                        "type": "string"
-                    },
-                    "c_macro": {
-                        "type": "boolean"
-                    },
-                    "key_count": {"$ref": "qmk.definitions.v1#/key_unit"},
-                    "layout": {
-                        "type": "array",
-                        "items": {
-                            "type": "object",
-                            "additionalProperties": false,
-                            "properties": {
-                                "label": {"type": "string"},
-                                "matrix": {
-                                    "type": "array",
-                                    "minItems": 2,
-                                    "maxItems": 2,
-                                    "items": {
-                                        "type": "number",
-                                        "min": 0,
-                                        "multipleOf": 1
-                                    }
-                                },
-                                "key_count": {"$ref": "qmk.definitions.v1#/key_unit"},
-                                "r": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
-                                "rx": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
-                                "ry": {"$ref": "qmk.definitions.v1#/unsigned_decimal"},
-                                "h": {"$ref": "qmk.definitions.v1#/key_unit"},
-                                "w": {"$ref": "qmk.definitions.v1#/key_unit"},
-                                "x": {"$ref": "qmk.definitions.v1#/key_unit"},
-                                "y": {"$ref": "qmk.definitions.v1#/key_unit"}
-                            }
-                        }
-                    }
-                }
-            }
-        },
-        "leader_key": {
-            "type": "object",
-            "properties": {
-                "timing": {"type": "boolean"},
-                "strict_processing": {"type": "boolean"},
-                "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
-            }
-        },
-        "matrix_pins": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "custom": {"type": "boolean"},
-                "custom_lite": {"type": "boolean"},
-                "ghost": {"type": "boolean"},
-                "io_delay": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "direct": {
-                    "type": "array",
-                    "items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
-                },
-                "cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
-                "rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
-                "unused": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
-            }
-        },
-        "mouse_key": {
-            "type": "object",
-            "properties": {
-                "enabled": {"type": "boolean"},
-                "delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-                "interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-                "max_speed": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-                "time_to_max": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-                "wheel_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
-            }
-        },
-        "oneshot": {
-            "type": "object",
-            "properties": {
-                "tap_toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
-            }
-        },
-        "rgblight": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "animations": {
-                    "type": "object",
-                    "additionalProperties": {
-                        "type": "boolean"
-                    }
-                },
-                "brightness_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "hue_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "layers": {
-                    "type": "object",
-                    "additionalProperties": false,
-                    "properties": {
-                        "blink": {"type": "boolean"},
-                        "enabled": {"type": "boolean"},
-                        "max": {
-                            "type": "number",
-                            "min": 1,
-                            "max": 32,
-                            "multipleOf": 1
-                        },
-                        "override_rgb": {"type": "boolean"}
-                    }
-                },
-                "led_count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "max_brightness": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "rgbw": {"type": "boolean"},
-                "saturation_steps": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "sleep": {"type": "boolean"},
-                "split": {"type": "boolean"},
-                "split_count": {
-                    "type": "array",
-                    "minLength": 2,
-                    "maxLength": 2,
-                    "items": {"$ref": "qmk.definitions.v1#/unsigned_int"}
-                }
-            }
-        },
-        "split": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "enabled": {"type": "boolean"},
-                "matrix_grid": {
-                    "type": "array",
-                    "items": {"$ref": "qmk.definitions.v1#/mcu_pin"}
-                },
-                "matrix_pins": {
-                    "type": "object",
-                    "additionalProperties": false,
-                    "properties": {
-                        "right": {
-                            "type": "object",
-                            "additionalProperties": false,
-                            "properties": {
-                                "direct": {
-                                    "type": "array",
-                                    "items": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
-                                },
-                                "cols": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
-                                "rows": {"$ref": "qmk.definitions.v1#/mcu_pin_array"},
-                                "unused": {"$ref": "qmk.definitions.v1#/mcu_pin_array"}
-                            }
-                        }
-                    }
-                },
-                "main": {
-                    "type": "string",
-                    "enum": ["eeprom", "left", "matrix_grid", "pin", "right"]
-                },
-                "soft_serial_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "soft_serial_speed": {
-                    "type": "number",
-                    "min": 0,
-                    "max": 5,
-                    "multipleOf": 1
-                },
-                "transport": {
-                    "type": "object",
-                    "additionalProperties": false,
-                    "properties": {
-                        "protocol": {
-                            "type": "string",
-                            "enum": ["custom", "i2c", "serial", "serial_usart"]
-                        },
-                        "sync_matrix_state": {"type": "boolean"},
-                        "sync_modifiers": {"type": "boolean"}
-                    }
-                },
-                "usb_detect": {
-                    "type": "object",
-                    "additionalProperties": false,
-                    "properties": {
-                        "enabled": {"type": "boolean"},
-                        "polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                        "timeout": {"$ref": "qmk.definitions.v1#/unsigned_int"}
-                    }
-                }
-            }
-        },
-        "tags": {
-            "type": "array",
-            "items": {"type": "string"}
-        },
-        "tapping": {
-            "type": "object",
-            "properties": {
-                "force_hold": {"type": "boolean"},
-                "force_hold_per_key": {"type": "boolean"},
-                "ignore_mod_tap_interrupt": {"type": "boolean"},
-                "ignore_mod_tap_interrupt_per_key": {"type": "boolean"},
-                "permissive_hold": {"type": "boolean"},
-                "permissive_hold_per_key": {"type": "boolean"},
-                "retro": {"type": "boolean"},
-                "retro_per_key": {"type": "boolean"},
-                "term": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                "term_per_key": {"type": "boolean"},
-                "toggle": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-            }
-        },
-        "usb": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "device_ver": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
-                "force_nkro": {"type": "boolean"},
-                "pid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
-                "vid": {"$ref": "qmk.definitions.v1#/hex_number_4d"},
-                "max_power": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "no_startup_check": {"type": "boolean"},
-                "polling_interval": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "shared_endpoint": {
-                    "type": "object",
-                    "additionalProperties": false,
-                    "properties": {
-                        "keyboard": {"type": "boolean"},
-                        "mouse": {"type": "boolean"}
-                    }
-                },
-                "suspend_wakeup_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "wait_for": {"type": "boolean"},
-            }
-        },
-        "qmk": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "keys_per_scan": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "tap_keycode_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-                "tap_capslock_delay": {"$ref": "qmk.definitions.v1#/unsigned_int_8"},
-            }
-        },
-        "qmk_lufa_bootloader": {
-            "type": "object",
-            "additionalProperties": false,
-            "properties": {
-                "esc_output": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "esc_input": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "led": {"$ref": "qmk.definitions.v1#/mcu_pin"},
-                "speaker": {"$ref": "qmk.definitions.v1#/mcu_pin"}
-            }
-        }
-    }
-}

data/schemas/keymap.jsonschema

@@ -1,24 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "qmk.keymap.v1",
-    "title": "Keymap Information",
-    "type": "object",
-    "properties": {
-        "author": {"type": "string"},
-        "keyboard": {"$ref": "qmk.definitions.v1#/text_identifier"},
-        "keymap": {"$ref": "qmk.definitions.v1#/text_identifier"},
-        "layout": {"$ref": "qmk.definitions.v1#/layout_macro"},
-        "layers": {
-            "type": "array",
-            "items": {
-                "type": "array",
-                "items": {"type": "string"}
-            }
-        },
-        "config": {"$ref": "qmk.keyboard.v1"},
-        "notes": {
-            "type": "string",
-            "description": "asdf"
-        }
-    }
-}

data/schemas/true.jsonschema

@@ -1 +0,0 @@
-true

data/templates/avr/readme.md

@@ -1,27 +0,0 @@
-# %KEYBOARD%
-
-![%KEYBOARD%](imgur.com image replace me!)
-
-*A short description of the keyboard/project*
-
-* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
-* Hardware Supported: *The PCBs, controllers supported*
-* Hardware Availability: *Links to where you can find this hardware*
-
-Make example for this keyboard (after setting up your build environment):
-
-    make %KEYBOARD%:default
-
-Flashing example for this keyboard:
-
-    make %KEYBOARD%:default:flash
-
-See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
-
-## Bootloader
-
-Enter the bootloader in 3 ways:
-
-* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
-* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
-* **Keycode in layout**: Press the key mapped to `RESET` if it is available

data/templates/avr/rules.mk

@@ -1,22 +0,0 @@
-# MCU name
-MCU = atmega32u4
-
-# Bootloader selection
-BOOTLOADER = atmel-dfu
-
-# Build Options
-#   change yes to no to disable
-#
-BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
-MOUSEKEY_ENABLE = yes       # Mouse keys
-EXTRAKEY_ENABLE = yes       # Audio control and System control
-CONSOLE_ENABLE = no         # Console for debug
-COMMAND_ENABLE = no         # Commands for debug and configuration
-# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
-SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
-# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
-NKRO_ENABLE = no            # USB Nkey Rollover
-BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
-RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
-BLUETOOTH_ENABLE = no       # Enable Bluetooth
-AUDIO_ENABLE = no           # Audio output

data/templates/ps2avrgb/readme.md

@@ -1,28 +0,0 @@
-# %KEYBOARD%
-
-![%KEYBOARD%](imgur.com image replace me!)
-
-*A short description of the keyboard/project*
-
-* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
-* Hardware Supported: *The PCBs, controllers supported*
-* Hardware Availability: *Links to where you can find this hardware*
-
-Make example for this keyboard (after setting up your build environment):
-
-    make %KEYBOARD%:default
-
-Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
-
-    make %KEYBOARD%:default:flash
-
-See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
-
-## Bootloader
-
-Enter the bootloader in 3 ways:
-
-* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
-* **BootloadHID reset**: Hold down the key connected to the `A0` and `B0` pins on the MCU if it is known (often top left or bottom left) and plug in the keyboard
-* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
-* **Keycode in layout**: Press the key mapped to `RESET` if it is available

data/templates/ps2avrgb/rules.mk

@@ -1,19 +0,0 @@
-# MCU name
-MCU = atmega32a
-
-# Bootloader selection
-BOOTLOADER = bootloadHID
-
-# Build Options
-#   change yes to no to disable
-#
-BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
-MOUSEKEY_ENABLE = yes       # Mouse keys
-EXTRAKEY_ENABLE = yes       # Audio control and System control
-CONSOLE_ENABLE = no         # Console for debug
-COMMAND_ENABLE = no         # Commands for debug and configuration
-# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
-SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
-BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
-RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
-WS2812_DRIVER = i2c

docs/ChangeLog/20200829.md

@@ -5,7 +5,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch
 
 ## Changes Requiring User Action :id=changes-requiring-user-action
 
-### Relocated Keyboards :id=relocated-keyboards
+### Relocated Keyboards :id-relocated-keyboards
 
 #### The Key Company project consolidation ([#9547](https://github.com/qmk/qmk_firmware/pull/9547))
 #### relocating boards by flehrad to flehrad/ folder ([#9635](https://github.com/qmk/qmk_firmware/pull/9635))

docs/ChangeLog/20201128.md

@@ -5,7 +5,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch
 
 ## Changes Requiring User Action :id=changes-requiring-user-action
 
-### Relocated Keyboards :id=relocated-keyboards
+### Relocated Keyboards :id-relocated-keyboards
 
 #### Reduce Helix keyboard build variation ([#8669](https://github.com/qmk/qmk_firmware/pull/8669))
 

docs/ChangeLog/20210227.md

@@ -1,169 +0,0 @@
-# QMK Breaking Changes - 2021 February 27 Changelog
-
-## Changes Requiring User Action
-
-The following keyboards have had their source moved within QMK:
-
-Old Keyboard Name | New Keyboard Name
-:---------------- | :----------------
-bear_65 | jacky_studio/bear_65
-s7_elephant/rev1 | jacky_studio/s7_elephant/rev1
-s7_elephant/rev2 | jacky_studio/s7_elephant/rev2
-aplx6 | aplyard/aplx6/rev1
-southpaw75 | fr4/southpaw75
-
-The [Aplyard Aplx6 rev2](https://github.com/qmk/qmk_firmware/tree/0.12.0/keyboards/aplyard/aplx6/rev1) and the [FR4Boards Unix60](https://github.com/qmk/qmk_firmware/tree/0.12.0/keyboards/fr4/unix60) have also been added as part of these changes.
-
-Additionally, the `handwired/bluepill/bluepill70` keyboard has been removed.
-
-## Core Changes
-
-### ChibiOS Update and Config Migration
-
-QMK's ChibiOS and ChibiOS-Contrib submodules have been updated to version 20.3.2.
-
-Along with this, QMK now provides default configuration files for all commonly-supported ARM microcontrollers running on ChibiOS. As such, keyboards are now only required to define settings which differ from the defaults, thereby reducing the size of pull requests for keyboards running atop ChibiOS.
-
-### QMK Infrastructure and Internals
-
-Python is now required to build QMK. The minimum Python version has been increased to 3.7.
-
-The power of `info.json` has been massively expanded. Most keyboard parameters can now be expressed in `info.json` instead of `config.h`/`rules.mk`. This should make maintaining keyboards easier, and will enable tooling that can allow non-technical users to add and maintain QMK keyboards without writing any code.
-
-To ease migration a new command has been provided, `qmk generate-info-json -kb <keyboard>`. You can use this command to generate a complete `info.json` file for a keyboard and then remove the duplicate information from `config.h` and `rules.mk`. 
-
-Detailed example showing how to generate a new info.json and identify duplicate keys:
-
-```
-user@hostname:~/qmk_firmware/keyboards/lets_split:0$ qmk generate-info-json > new-info.json
-user@hostname:~/qmk_firmware/keyboards/lets_split:0$ mv new-info.json info.json
-user@hostname:~/qmk_firmware/keyboards/lets_split:0$ qmk info
-⚠ lets_split/rev2: DEBOUNCE in config.h is overwriting debounce in info.json
-⚠ lets_split/rev2: DEVICE_VER in config.h is overwriting usb.device_ver in info.json
-⚠ lets_split/rev2: DIODE_DIRECTION in config.h is overwriting diode_direction in info.json
-⚠ lets_split/rev2: MANUFACTURER in config.h is overwriting manufacturer in info.json
-⚠ lets_split/rev2: RGB_DI_PIN in config.h is overwriting rgblight.pin in info.json
-⚠ lets_split/rev2: RGBLED_NUM in config.h is overwriting rgblight.led_count in info.json
-⚠ lets_split/rev2: PRODUCT_ID in config.h is overwriting usb.pid in info.json
-⚠ lets_split/rev2: VENDOR_ID in config.h is overwriting usb.vid in info.json
-⚠ lets_split/rev2: Matrix pins are specified in both info.json and config.h, the config.h values win.
-⚠ lets_split/rev2: LAYOUTS in rules.mk is overwriting community_layouts in info.json
-⚠ lets_split/rev2: Feature bootmagic is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature mousekey is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature extrakey is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature console is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature command is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature nkro is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature backlight is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature midi is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature audio is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature unicode is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature bluetooth is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature rgblight is specified in both info.json and rules.mk, the rules.mk value wins.
-⚠ lets_split/rev2: Feature sleep_led is specified in both info.json and rules.mk, the rules.mk value wins.
-Keyboard Name: Let's Split
-Manufacturer: Wootpatoot
-Website:
-Maintainer: QMK Community
-Keyboard Folder: lets_split/rev2
-Layouts: LAYOUT, LAYOUT_ortho_4x12
-Size: 13 x 4
-Processor: atmega32u4
-Bootloader: caterina
-```
-
-## Detailed Change List
-
-### Changes Requiring User Action
-
-* Refactor Jacky's boards (Bear65 and S7 Elephant) ([#10528](https://github.com/qmk/qmk_firmware/pull/10528), [#11981](https://github.com/qmk/qmk_firmware/pull/11981))
-* Remove handwired/bluepill ([#11415](https://github.com/qmk/qmk_firmware/pull/11415))
-* Aplyard Aplx6 Added rev2 & move rev1+rev2 to parent folder ([#10973](https://github.com/qmk/qmk_firmware/pull/10973))
-* added `unix60`, moved together with `southpaw75` into `fr4` folder ([#11195](https://github.com/qmk/qmk_firmware/pull/11195))
-
-### Fixes
-
-* GCC 10 can now compile Drop Alt firmware ([#9485](https://github.com/qmk/qmk_firmware/pull/9485))
-* Fix compiling on `develop` branch ([#11409](https://github.com/qmk/qmk_firmware/pull/11409))
-* Fix broken keyboards and keymaps ([#11412](https://github.com/qmk/qmk_firmware/pull/11412), [#11427](https://github.com/qmk/qmk_firmware/pull/11427), [#11448](https://github.com/qmk/qmk_firmware/pull/11448), [#11447](https://github.com/qmk/qmk_firmware/pull/11447), [#11473](https://github.com/qmk/qmk_firmware/pull/11473), [#11584](https://github.com/qmk/qmk_firmware/pull/11584), [#11600](https://github.com/qmk/qmk_firmware/pull/11600))
-* Fixed up build dependencies so that generated files are made available before compiling any object files ([#11435](https://github.com/qmk/qmk_firmware/pull/11435))
-* Formatting fixes ([`378edd9`](https://github.com/qmk/qmk_firmware/commit/378edd9491f2ab0d3d8a970c9a8e64bc03ca15cf), [#11594](https://github.com/qmk/qmk_firmware/pull/11594), [`27749e1`](https://github.com/qmk/qmk_firmware/commit/27749e1c967c02c05e62a89a0ae2776dd7e5158c))
-* Include `stdbool.h` in `uart.h` to fix compiler errors ([#11728](https://github.com/qmk/qmk_firmware/pull/11728))
-* Decouple USB events from the USB interrupt handler in ChibiOS ([#10437](https://github.com/qmk/qmk_firmware/pull/10437))
-  * Fixes an issue while using Backlight and External EEPROM at the same time that would cause the MCU to lock up.
-* Address wake from sleep instability ([#11450](https://github.com/qmk/qmk_firmware/pull/11450))
-* Fix pressing media key on a momentarily activated layer may lead to missing key up events ([#11162](https://github.com/qmk/qmk_firmware/pull/11162))
-* Fix an RGB initialisation bug on Massdrop keyboards ([#12022](https://github.com/qmk/qmk_firmware/pull/12022))
-* Fix file encoding errors on Windows, and layouts not correctly merging into info.json ([#12039](https://github.com/qmk/qmk_firmware/pull/12039))
-
-### Additions and Enhancements
-
-* Allow configuration of serial USART timeout ([#11057](https://github.com/qmk/qmk_firmware/pull/11057))
-* Added Sync Timer feature for Split Common keyboards ([#10997](https://github.com/qmk/qmk_firmware/pull/10997))
-* Add modifier state to the Split Common transport ([#10400](https://github.com/qmk/qmk_firmware/pull/10400))
-* Add Pix keyboard by sendz (`sendyyeah/pix`) ([#11154](https://github.com/qmk/qmk_firmware/pull/11154))
-* Implement option for kinetic mouse movement algorithm for mouse keys ([#6739](https://github.com/qmk/qmk_firmware/pull/6739))
-* Improved Language Specific Keycodes for US International and Extended Layouts ([#11307](https://github.com/qmk/qmk_firmware/pull/11307))
-* Modified `QWIIC_ENABLE` in `rules.mk` to be yes/no choice, adding `QWIIC_DRIVERS` to allow for inclusion of specific drivers ([#11426](https://github.com/qmk/qmk_firmware/pull/11426))
-* Allow AVR-based keyboards to override the `bootloader_jump` function ([#11418](https://github.com/qmk/qmk_firmware/pull/11418))
-* Refine RGBLight Twinkle effect to be smoother (use breathing curve) ([#11350](https://github.com/qmk/qmk_firmware/pull/11350))
-* Keep track of last matrix activity ([#10730](https://github.com/qmk/qmk_firmware/pull/10730), [`ab375d3`](https://github.com/qmk/qmk_firmware/commit/ab375d3d075c105f09a1ddd0e155f178225518bc), [#11552](https://github.com/qmk/qmk_firmware/pull/11552))
-* fix `matrix_io_delay()` timing in `quantum/matrix.c` ([#9603](https://github.com/qmk/qmk_firmware/pull/9603))
-* Keep track of encoder activity ([#11595](https://github.com/qmk/qmk_firmware/pull/11595))
-* Backport ChibiOS Audio changes from ZSA ([#11687](https://github.com/qmk/qmk_firmware/pull/11687))
-* Add support for 8 buttons to mouse report ([#10807](https://github.com/qmk/qmk_firmware/pull/10807))
-* Allow `post_config.h` to be implemented in userspace ([#11519](https://github.com/qmk/qmk_firmware/pull/11519))
-* Adds AT90USB162 support ([#11570](https://github.com/qmk/qmk_firmware/pull/11570))
-* Stop sounds when suspended ([#11553](https://github.com/qmk/qmk_firmware/pull/11553))
-* Revamp spidey3 userspace and keymaps ([#11768](https://github.com/qmk/qmk_firmware/pull/11768))
-* Add support for analog USBPD on STM32G4xx ([#11824](https://github.com/qmk/qmk_firmware/pull/11824))
-* Master matrix can now be transported to the slave side in Split Common keyboards ([#11046](https://github.com/qmk/qmk_firmware/pull/11046))
-* RGBLight: Allow configurable default settings ([#11912](https://github.com/qmk/qmk_firmware/pull/11912))
-* Add `tap_code_delay(code, delay)` ([#11913](https://github.com/qmk/qmk_firmware/pull/11913), [#11938](https://github.com/qmk/qmk_firmware/pull/11938))
-
-### Clean-ups and Optimizations
-
-* Fix duplicate `I2C_KEYMAP_START` define ([#11237](https://github.com/qmk/qmk_firmware/pull/11237))
-* Rewrite APA102 support for RGBLight ([#10894](https://github.com/qmk/qmk_firmware/pull/10894))
-* Update ADB Protocol implementation in TMK Core ([#11168](https://github.com/qmk/qmk_firmware/pull/11168))
-* Remove unused `action_get_macro()` usages in user files ([#11165](https://github.com/qmk/qmk_firmware/pull/11165))
-* Remove `QMK_KEYBOARD_CONFIG_H` ([#11576](https://github.com/qmk/qmk_firmware/pull/11576))
-* Remove duplicated housekeeping in `arm_atsam` ([#11672](https://github.com/qmk/qmk_firmware/pull/11672))
-* UART driver refactor ([#11637](https://github.com/qmk/qmk_firmware/pull/11637))
-* Move `transport.c` to `QUANTUM_LIB_SRC` ([#11751](https://github.com/qmk/qmk_firmware/pull/11751))
-* Remove `MIDI_ENABLE_STRICT` from user keymaps ([#11750](https://github.com/qmk/qmk_firmware/pull/11750))
-* Remove legacy print backward compatiblitly ([#11805](https://github.com/qmk/qmk_firmware/pull/11805))
-* Migrate mousekey to quantum ([#11804](https://github.com/qmk/qmk_firmware/pull/11804))
-* remove deprecated `qmk json-keymap` ([#11823](https://github.com/qmk/qmk_firmware/pull/11823))
-* Remove FAUXCLICKY feature (deprecated) ([#11829](https://github.com/qmk/qmk_firmware/pull/11829))
-* Refactor platform logic within `print.h` ([#11863](https://github.com/qmk/qmk_firmware/pull/11863))
-* Audio system overhaul ([#11820](https://github.com/qmk/qmk_firmware/pull/11820))
-* Output selection: Remove "USB and BT" option for Bluetooth ([#11940](https://github.com/qmk/qmk_firmware/pull/11940))
-* `tmk_core/common/action.c`: refactor for code size; merge multiple `case`s into one ([#11943](https://github.com/qmk/qmk_firmware/pull/11943))
-* Remove rules and settings from user keymaps that are already defined at keyboard level ([#11966](https://github.com/qmk/qmk_firmware/pull/11966))
-
-### QMK Infrastructure and Internals
-
-* bump to python 3.7 ([#11408](https://github.com/qmk/qmk_firmware/pull/11408))
-* `develop` branch is now formatted as part of CI tasks ([#11893](https://github.com/qmk/qmk_firmware/pull/11893), [#11905](https://github.com/qmk/qmk_firmware/pull/11905), [#11907](https://github.com/qmk/qmk_firmware/pull/11907), [#11928](https://github.com/qmk/qmk_firmware/pull/11928), [#11936](https://github.com/qmk/qmk_firmware/pull/11936))
-* Configure keyboard matrix from info.json ([#10817](https://github.com/qmk/qmk_firmware/pull/10817))
-* Validate our JSON data using json_schema ([#11101](https://github.com/qmk/qmk_firmware/pull/11101))
-* Use the schema to eliminate custom code ([#11108](https://github.com/qmk/qmk_firmware/pull/11108))
-* Add support for specifying BOARD in `info.json` ([#11492](https://github.com/qmk/qmk_firmware/pull/11492))
-* Document how to add data driven configurations ([#11502](https://github.com/qmk/qmk_firmware/pull/11502))
-* Process info.json rules ahead of userspace rules ([#11542](https://github.com/qmk/qmk_firmware/pull/11542))
-* Remove duplicate manufacturer definitions ([#11544](https://github.com/qmk/qmk_firmware/pull/11544))
-* Update list of MCUs in `keyboard.jsonschema` to mirror `qmk.constants.py` ([#11688](https://github.com/qmk/qmk_firmware/pull/11688))
-* Create a system to map between `info.json` and `config.h`/`rules.mk` ([#11548](https://github.com/qmk/qmk_firmware/pull/11548))
-* Make LAYOUT parsing more robust ([#12000](https://github.com/qmk/qmk_firmware/pull/12000))
-
-
-### ChibiOS Update and Config Migration
-
-* Add board specific to Proton-C, with usual defaults turned on to match Pro-Micro ([#10976](https://github.com/qmk/qmk_firmware/pull/10976))
-* Disable almost all ChibiOS subsystems in default configs ([#11111](https://github.com/qmk/qmk_firmware/pull/11111))
-* Config Migrations ([#10418](https://github.com/qmk/qmk_firmware/pull/10418), [#11123](https://github.com/qmk/qmk_firmware/pull/11123), [#11261](https://github.com/qmk/qmk_firmware/pull/11261), [#11413](https://github.com/qmk/qmk_firmware/pull/11413), [#11414](https://github.com/qmk/qmk_firmware/pull/11414), [#11495](https://github.com/qmk/qmk_firmware/pull/11495), [#11504](https://github.com/qmk/qmk_firmware/pull/11504), [#11529](https://github.com/qmk/qmk_firmware/pull/11529), [#11588](https://github.com/qmk/qmk_firmware/pull/11588), [#11598](https://github.com/qmk/qmk_firmware/pull/11598), [#11607](https://github.com/qmk/qmk_firmware/pull/11607), [#11617](https://github.com/qmk/qmk_firmware/pull/11617), [#11620](https://github.com/qmk/qmk_firmware/pull/11620), [#11630](https://github.com/qmk/qmk_firmware/pull/11630), [#11646](https://github.com/qmk/qmk_firmware/pull/11646), [#11689](https://github.com/qmk/qmk_firmware/pull/11689), [#11846](https://github.com/qmk/qmk_firmware/pull/11846), [#11927](https://github.com/qmk/qmk_firmware/pull/11927), [#12001](https://github.com/qmk/qmk_firmware/pull/12001))
-* Disable subsystems repo-wide ([#11449](https://github.com/qmk/qmk_firmware/pull/11449))
-* Leftover early initialisation conversions ([#11615](https://github.com/qmk/qmk_firmware/pull/11615))
-* Fix up comments showing how to execute config migration ([#11621](https://github.com/qmk/qmk_firmware/pull/11621))
-* Add STM32G431 and STM32G474 board definitions ([#11793](https://github.com/qmk/qmk_firmware/pull/11793))

docs/ChangeLog/20210529.md

@@ -1,227 +0,0 @@
-# QMK Breaking Changes - 2021 May 29 Changelog
-
-## Notable Changes :id=notable-changes
-
-### RGB Matrix support for split common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) :id=rgb-matrix-split-common
-
-Split boards can now use RGB Matrix without defining a custom matrix.
-
-### Teensy 3.6 support ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) :id=teensy-3-6-support
-
-Added support for MK66F18 (Teensy 3.6) microcontroller.
-
-### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) :id=new-command-qmk-console
-
-A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages.
-
-### Improved command: qmk config :id=improve-command-qmk-config
-
-We've updated the `qmk config` command to show only the configuration items you have actually set. You can now display (almost) all of the available configuration options, along with their default values, using `qmk config -a`.
-
-### LED Matrix Improvements ([#12509](https://github.com/qmk/qmk_firmware/pull/12509), [#12580](https://github.com/qmk/qmk_firmware/pull/12580), [#12588](https://github.com/qmk/qmk_firmware/pull/12588), [#12633](https://github.com/qmk/qmk_firmware/pull/12633), [#12651](https://github.com/qmk/qmk_firmware/pull/12651), [#12685](https://github.com/qmk/qmk_firmware/pull/12685)) :id=led-matrix-improvements
-
-LED Matrix has been improved with effects, CIE1931 curves, and a task system.
-
-## Changes Requiring User Action :id=changes-requiring-user-action
-
-### Updated Keyboard Codebases :id=updated-keyboard-codebases
-
-* Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978))
-* Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613))
-* [Keyboard] updated a vendor name / fixed minor keymap issues ([#12881](https://github.com/qmk/qmk_firmware/pull/12881))
-* [Keyboard] Corne - Remove legacy revision support ([#12226](https://github.com/qmk/qmk_firmware/pull/12226))
-
-The following keyboards have had their source moved within QMK:
-
-Old Keyboard Name | New Keyboard Name
-:---------------- | :----------------
-crkbd/rev1/common | crkbd/rev1
-function96 | function96/v1
-nckiibs/flatbread60 | delikeeb/flatbread60
-nckiibs/vaguettelite | delikeeb/vaguettelite
-nckiibs/vanana/rev1 | delikeeb/vanana/rev1
-nckiibs/vanana/rev2 | delikeeb/vanana/rev2
-nckiibs/vaneela | delikeeb/vaneela
-nckiibs/vaneelaex | delikeeb/vaneelaex
-nckiibs/waaffle/rev3/elite_c | delikeeb/waaffle/rev3/elite_c
-nckiibs/waaffle/rev3/pro_micro | delikeeb/waaffle/rev3/pro_micro
-
-The [Function96 V2](https://github.com/qmk/qmk_firmware/tree/0.13.0/keyboards/function96/v2) has also been added as part of these changes.
-
-The codebase for the [Durgod K320](https://github.com/qmk/qmk_firmware/tree/0.13.0/keyboards/durgod/k320) has been reworked in anticipation of additional Durgod keyboards gaining QMK support.
-
-Additionally, the `crkbd/rev1/legacy` keyboard has been removed.
-
-### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) :id=bootmagic-deprecation-and-refactor
-
-QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
-
-This pull request changes the behavior of `BOOTMAGIC_ENABLE` such that specifying `BOOTMAGIC_ENABLE = yes` enables Bootmagic Lite instead of full Bootmagic.
-
-If attempts to use Bootmagic functionality result in unexpected behavior, check your `rules.mk` file and change the `BOOTMAGIC_ENABLE` setting to specify either `lite` or `full`.
-
-#### Tentative Deprecation Schedule
-
-This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`:
-
-- From 2021 May 29, setting `BOOTMAGIC_ENABLE = yes` will enable Bootmagic Lite instead of full Bootmagic.
-- From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
-- From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
-
-### Removal of LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) :id=removal-of-layout-kc
-
-We've removed support for `LAYOUT_kc` macros, if your keymap uses one you will need to update it use a regular `LAYOUT` macro.
-
-### Encoder callbacks are now boolean ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985)) :id=encoder-callback-boolean
-
-To allow for keyboards to override (or not) keymap level code the `encoder_update_kb` function has been changed from `void` to `bool`. You will need to update your function definition to reflect this and ensure that you return a `true` or `false` value.
-
-Example code before change:
-
-```c
-void encoder_update_kb(uint8_t index, bool clockwise) {
-    encoder_update_user(index, clockwise);
-}
-
-void encoder_update_user(uint8_t index, bool clockwise) {
-    if (index == 0) { /* First encoder */
-        if (clockwise) {
-            tap_code(KC_PGDN);
-        } else {
-            tap_code(KC_PGUP);
-        }
-    } else if (index == 1) { /* Second encoder */
-        if (clockwise) {
-            tap_code(KC_DOWN);
-        } else {
-            tap_code(KC_UP);
-        }
-    }
-}
-```
-
-Example code after change:
-
-```c
-bool encoder_update_kb(uint8_t index, bool clockwise) {
-    return encoder_update_user(index, clockwise);
-}
-
-bool encoder_update_user(uint8_t index, bool clockwise) {
-    if (index == 0) { /* First encoder */
-        if (clockwise) {
-            tap_code(KC_PGDN);
-        } else {
-            tap_code(KC_PGUP);
-        }
-    } else if (index == 1) { /* Second encoder */
-        if (clockwise) {
-            tap_code(KC_DOWN);
-        } else {
-            tap_code(KC_UP);
-        }
-    }
-    return true; 
-    // If you return true, this will allow the keyboard level code to run, as well. 
-    //Returning false will override the keyboard level code. Depending on how the keyboard level function is set up.
-}
-```
-
-## Core Changes :id=core-changes
-
-### Fixes :id=core-fixes
-
-* Fix connection issue in split keyboards when slave and OLED display are connected via I2C (fixes #9335) ([#11487](https://github.com/qmk/qmk_firmware/pull/11487))
-* Terrazzo: Fix wrong LED Matrix function names ([#12561](https://github.com/qmk/qmk_firmware/pull/12561))
-* Apply the "NO_LIMITED_CONTROLLER_CONNECT" fix to atmega16u2 ([#12482](https://github.com/qmk/qmk_firmware/pull/12482))
-* Fix comment parsing ([#12750](https://github.com/qmk/qmk_firmware/pull/12750))
-* Turn OLED off on suspend in soundmonster Corne keymap ([#10419](https://github.com/qmk/qmk_firmware/pull/10419))
-* Fixup build errors on `develop` branch. ([#12723](https://github.com/qmk/qmk_firmware/pull/12723))
-* Fix syntax error when compiling for ARM ([#12866](https://github.com/qmk/qmk_firmware/pull/12866))
-* Add missing LED Matrix suspend code to suspend.c ([#12878](https://github.com/qmk/qmk_firmware/pull/12878))
-* Fix spelling mistake regarding LED Matrix in split_common. ([#12888](https://github.com/qmk/qmk_firmware/pull/12888))
-* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap ([#12895](https://github.com/qmk/qmk_firmware/pull/12895))
-* Fixup housekeeping from being invoked twice per loop. ([#12933](https://github.com/qmk/qmk_firmware/pull/12933))
-* wait for matrix row signal to go HIGH for every row ([#12945](https://github.com/qmk/qmk_firmware/pull/12945))
-* ensure we do not conflict with existing keymap aliases ([#12976](https://github.com/qmk/qmk_firmware/pull/12976))
-* [Keyboard] Fix Terrazzo build failure ([#12977](https://github.com/qmk/qmk_firmware/pull/12977))
-* Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864))
-
-### Additions and Enhancements :id=core-additions
-
-* ARM - Refactor SLEEP_LED to support more platforms ([#8403](https://github.com/qmk/qmk_firmware/pull/8403))
-* Add ability to toggle One Shot functionality ([#4198](https://github.com/qmk/qmk_firmware/pull/4198))
-* Add RGB Matrix support to Split Common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055))
-* Add support for complementary outputs to the ChibiOS WS2812 PWM driver ([#11988](https://github.com/qmk/qmk_firmware/pull/11988))
-* Enable RGB Matrix for Corne ([#12091](https://github.com/qmk/qmk_firmware/pull/12091))
-* Set default OLED Update Interval for Split Keyboards to improve matrix scan performance ([#12107](https://github.com/qmk/qmk_firmware/pull/12107))
-* Add support for MK66F18 (Teensy 3.6) micro controller ([#12258](https://github.com/qmk/qmk_firmware/pull/12258))
-* Split RGB Matrix support for RGBKB Zygomorph ([#11083](https://github.com/qmk/qmk_firmware/pull/11083))
-* Add baudrate and circular buffer to ARM WS2812 SPI config ([#12216](https://github.com/qmk/qmk_firmware/pull/12216))
-* Add keyboard level weak function for slave matrix scan ([#12317](https://github.com/qmk/qmk_firmware/pull/12317))
-* Add link to schematic on EasyEDA for XD60 ([#12018](https://github.com/qmk/qmk_firmware/pull/12018))
-* Add Config functions for LED Matrix ([#12361](https://github.com/qmk/qmk_firmware/pull/12361))
-* Add pin definitions for MK66F18 ([#12419](https://github.com/qmk/qmk_firmware/pull/12419))
-* add kinesis/kint36 keyboard ([#10171](https://github.com/qmk/qmk_firmware/pull/10171))
-* Add support for producing UF2-format binaries. ([#12435](https://github.com/qmk/qmk_firmware/pull/12435))
-* Implement CIE1931 curve for LED Matrix ([#12417](https://github.com/qmk/qmk_firmware/pull/12417))
-* Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite ([#12172](https://github.com/qmk/qmk_firmware/pull/12172))
-* Add kzar keymap for Kinesis Advantage ([#12444](https://github.com/qmk/qmk_firmware/pull/12444))
-* LED Matrix: suspend code ([#12509](https://github.com/qmk/qmk_firmware/pull/12509))
-* LED Matrix: Task system ([#12580](https://github.com/qmk/qmk_firmware/pull/12580))
-* Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes ([#11935](https://github.com/qmk/qmk_firmware/pull/11935))
-* Enhancement of WPM feature ([#11727](https://github.com/qmk/qmk_firmware/pull/11727))
-* Add Per Key functionality for AutoShift ([#11536](https://github.com/qmk/qmk_firmware/pull/11536))
-* LED Matrix: Reactive effect buffers & advanced indicators ([#12588](https://github.com/qmk/qmk_firmware/pull/12588))
-* LED Matrix: support for Split keyboards ([#12633](https://github.com/qmk/qmk_firmware/pull/12633))
-* add setting to enable infinite timeout for leader key ([#6580](https://github.com/qmk/qmk_firmware/pull/6580), [#12721](https://github.com/qmk/qmk_firmware/pull/12721 "Fix bad PR merge for #6580"))
-* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx ([#12403](https://github.com/qmk/qmk_firmware/pull/12403))
-* Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) ([#12600](https://github.com/qmk/qmk_firmware/pull/12600))
-* Add support for STM32F446 MCU ([#12619](https://github.com/qmk/qmk_firmware/pull/12619))
-* Add STM32L433 and L443 support ([#12063](https://github.com/qmk/qmk_firmware/pull/12063))
-* Added OLED fade out support ([#12086](https://github.com/qmk/qmk_firmware/pull/12086))
-* New command: `qmk console` ([#12828](https://github.com/qmk/qmk_firmware/pull/12828))
-* LED Matrix: Effects! ([#12651](https://github.com/qmk/qmk_firmware/pull/12651))
-* Add setup, clone, and env to the list of commands we allow even with broken modules ([#12868](https://github.com/qmk/qmk_firmware/pull/12868))
-* LED Matrix: Documentation ([#12685](https://github.com/qmk/qmk_firmware/pull/12685))
-* Add function to allow repeated blinking of one layer ([#12237](https://github.com/qmk/qmk_firmware/pull/12237))
-* Add support for up to 4 IS31FL3733 drivers ([#12342](https://github.com/qmk/qmk_firmware/pull/12342))
-* Convert Encoder callbacks to be boolean functions ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985))
-* [Keymap] Update to Drashna keymap and user code (based on develop) ([#12936](https://github.com/qmk/qmk_firmware/pull/12936))
-* Add Full-duplex serial driver for ARM boards ([#9842](https://github.com/qmk/qmk_firmware/pull/9842))
-* Document LED_MATRIX_FRAMEBUFFER_EFFECTS ([#12987](https://github.com/qmk/qmk_firmware/pull/12987))
-* Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560), [#13024](https://github.com/qmk/qmk_firmware/pull/13024))
-* Add dire message about LUFA mass storage bootloader ([#13014](https://github.com/qmk/qmk_firmware/pull/13014))
-
-### Clean-ups and Optimizations :id=core-optimizations
-
-* Overhaul bootmagic logic to have single entrypoint ([#8532](https://github.com/qmk/qmk_firmware/pull/8532))
-* Refactor of USB code within split_common ([#11890](https://github.com/qmk/qmk_firmware/pull/11890))
-* Begin the process of deprecating `bin/qmk` in favor of the global CLI ([#12109](https://github.com/qmk/qmk_firmware/pull/12109))
-* LED Matrix: decouple from Backlight ([#12054](https://github.com/qmk/qmk_firmware/pull/12054))
-* Remove `FUNC()` ([#12161](https://github.com/qmk/qmk_firmware/pull/12161))
-* Move gpio wait logic to wait.h ([#12067](https://github.com/qmk/qmk_firmware/pull/12067))
-* LED Matrix: Clean up includes ([#12197](https://github.com/qmk/qmk_firmware/pull/12197))
-* Consistently use bin/qmk when that script is called ([#12286](https://github.com/qmk/qmk_firmware/pull/12286))
-* LED Matrix: Additional common_features.mk tweaks ([#12187](https://github.com/qmk/qmk_firmware/pull/12187))
-* LED Matrix: Fix up eeconfig code ([#12327](https://github.com/qmk/qmk_firmware/pull/12327))
-* Big quantum_keycodes cleanup ([#12249](https://github.com/qmk/qmk_firmware/pull/12249))
-* Fix up builds that are now too big for `develop` branch. ([#12495](https://github.com/qmk/qmk_firmware/pull/12495))
-* [Keyboard] kint36: switch to sym_eager_pk debouncing ([#12626](https://github.com/qmk/qmk_firmware/pull/12626))
-* [Keyboard] kint2pp: reduce input latency by ≈10ms ([#12625](https://github.com/qmk/qmk_firmware/pull/12625))
-* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. ([#12671](https://github.com/qmk/qmk_firmware/pull/12671))
-* Change RGB/LED Matrix to use a simple define for USB suspend ([#12697](https://github.com/qmk/qmk_firmware/pull/12697), [#12770](https://github.com/qmk/qmk_firmware/pull/12770 "Fixing transport's led/rgb matrix suspend state logic"))
-* Remove pointless SERIAL_LINK_ENABLE rules ([#12846](https://github.com/qmk/qmk_firmware/pull/12846))
-* Make Swap Hands use PROGMEM ([#12284](https://github.com/qmk/qmk_firmware/pull/12284))
-* Remove KEYMAP and LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160))
-* Rename `point_t` -> `led_point_t` ([#12864](https://github.com/qmk/qmk_firmware/pull/12864))
-* Deprecate `send_unicode_hex_string()` ([#12602](https://github.com/qmk/qmk_firmware/pull/12602))
-* [Keyboard] Remove redundant legacy and common headers for crkbd ([#13023](https://github.com/qmk/qmk_firmware/pull/13023))
-
-### QMK Infrastructure and Internals :id=qmk-internals
-
-* trivial change to trigger api update ([`b15288fb87`](https://github.com/qmk/qmk_firmware/commit/b15288fb87))
-* fix some references to bin/qmk that slipped in ([#12832](https://github.com/qmk/qmk_firmware/pull/12832))
-* Resolve a number of warnings in `qmk generate-api` ([#12833](https://github.com/qmk/qmk_firmware/pull/12833))
-* Fix another bin/qmk reference ([#12856](https://github.com/qmk/qmk_firmware/pull/12856))
-* Use milc.subcommand.config instead of qmk.cli.config ([#12915](https://github.com/qmk/qmk_firmware/pull/12915))

docs/ChangeLog/20210828.md

@@ -1,557 +0,0 @@
-# QMK Breaking Changes - 2021 August 28 Changelog
-
-## Notable Features :id=notable-features
-
-### Combo processing improvements ([#8591](https://github.com/qmk/qmk_firmware/pull/8591)) :id=combo-processing-improvements
-
-Combo processing has been reordered with respect to keypress handling, allowing for much better compatibility with mod taps.
-
-It is also now possible to define combos that have keys overlapping with other combos, triggering only one. For example, a combo of `A`, `B` can coexist with a longer combo of `A`, `B`, `C` -- previous functionality would trigger both combos if all three keys were pressed.
-
-### Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422)) :id=key-overrides
-
-QMK now has a new feature: [key overrides](https://docs.qmk.fm/#/feature_key_overrides). This feature allows for overriding the output of key combinations involving modifiers. As an example, pressing <kbd>Shift+2</kbd> normally results in an <kbd>@</kbd> on US-ANSI keyboard layouts -- the new key overrides allow for adding similar functionality, but for any <kbd>modifier + key</kbd> press.
-
-To illustrate, it's now possible to use the key overrides feature to translate <kbd>Shift + Backspace</kbd> into <kbd>Delete</kbd> -- an often-requested example of where this functionality comes in handy.
-
-There's far more to describe that what lives in this changelog, so head over to the [key overrides documentation](https://docs.qmk.fm/#/feature_key_overrides) for more examples and info.
-
-### Digitizer support ([#12851](https://github.com/qmk/qmk_firmware/pull/12851))
-
-QMK gained the ability to pretend to be a digitizer device -- much like a tablet device. A mouse uses delta-coordinates -- move up, move right -- but a digitizer works with absolute coordinates -- top left, bottom right.
-
-## Changes Requiring User Action :id=changes-requiring-user-action
-
-### Updated Keyboard Codebases :id=updated-keyboard-codebases
-
-The following keyboards have had their source moved within QMK:
-
-Old Keyboard Name             | New Keyboard Name
-------------------------------|---------------------------------------------------------
-aeboards/constellation        | aeboards/constellation/rev1, aeboards/constellation/rev2
-bakeneko65                    | bakeneko65/rev2, bakeneko65/rev3
-bm16a                         | kprepublic/bm16a
-bm16s                         | kprepublic/bm16s
-bm40hsrgb                     | kprepublic/bm40hsrgb
-bm43a                         | kprepublic/bm43a
-bm60poker                     | kprepublic/bm60poker
-bm60rgb                       | kprepublic/bm60rgb
-bm60rgb_iso                   | kprepublic/bm60rgb_iso
-bm68rgb                       | kprepublic/bm68rgb
-clawsome/gamebuddy            | clawsome/gamebuddy/v1_0, clawsome/gamebuddy/v1_m
-cospad                        | kprepublic/cospad
-custommk/genesis              | custommk/genesis/rev1, custommk/genesis/rev2
-daisy                         | ktec/daisy
-durgod/k320                   | durgod/k3x0/k320
-dztech/volcano660             | ilumkb/volcano660
-ergodone                      | ktec/ergodone
-gmmk/pro                      | gmmk/pro/ansi, gmmk/pro/iso
-handwired/p1800fl             | team0110/p1800fl
-jj40                          | kprepublic/jj40
-jj4x4                         | kprepublic/jj4x4
-jj50                          | kprepublic/jj50
-kyria                         | splitkb/kyria
-lazydesigners/the60           | lazydesigners/the60/rev1, lazydesigners/the60/rev2
-matrix/m12og                  | matrix/m12og/rev1, matrix/m12og/rev2
-mechlovin/hannah65/mechlovin9 | mechlovin/mechlovin9/rev1, mechlovin/mechlovin9/rev2
-peiorisboards/ixora           | coarse/ixora
-ramonimbao/mona               | ramonimbao/mona/v1, ramonimbao/mona/v1_1
-staryu                        | ktec/staryu
-tokyo60                       | tokyokeyboard/tokyo60
-vinta                         | coarse/vinta
-xd002                         | xiudi/xd002
-xd004                         | xiudi/xd004
-xd60                          | xiudi/xd60
-xd68                          | xiudi/xd68
-xd75                          | xiudi/xd75
-xd84                          | xiudi/xd84
-xd84pro                       | xiudi/xd84pro
-xd87                          | xiudi/xd87
-xd96                          | xiudi/xd96
-
-### Bootmagic Full Removal ([#13846](https://github.com/qmk/qmk_firmware/pull/13846)) :id=bootmagic-full-removal
-
-As noted during last breaking changes cycle, QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
-
-This pull request changes the behavior of `BOOTMAGIC_ENABLE` such that specifying `full` results in an error, allowing only `no`, `yes`, or `lite`.
-
-Currently `lite` is the equivalent of `yes` in `rules.mk`. Next cycle the use of the `lite` keyword will be prevented in favour of `yes` -- any new submissions should now be using `yes` or `no` to minimise disruption.
-
-#### Bootmagic Full Deprecation Schedule
-
-This is the current roadmap for the behavior of `BOOTMAGIC_ENABLE`:
-
-- (done) From 2021 May 29, setting `BOOTMAGIC_ENABLE = yes` will enable Bootmagic Lite instead of full Bootmagic.
-- (now) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
-- (next) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
-
-### DIP switch callbacks are now boolean ([#13399](https://github.com/qmk/qmk_firmware/pull/13399)) :id=dip-switch-boolean
-
-To match the encoder change last breaking changes cycle, DIP switch callbacks now return `bool`, too.
-
-Example code before change:
-
-```c
-void dip_switch_update_kb(uint8_t index, bool active) {
-    dip_switch_update_user(index, active);
-}
-
-void dip_switch_update_user(uint8_t index, bool active) {
-    switch (index) {
-        case 0:
-            if(active) { audio_on(); } else { audio_off(); }
-            break;
-    }
-}
-
-void dip_switch_update_mask_kb(uint32_t state) { 
-    dip_switch_update_mask_user(state);
-}
-
-void dip_switch_update_mask_user(uint32_t state) {
-    if (state & (1UL<<0) && state & (1UL<<1)) {
-        layer_on(_ADJUST); // C on esc
-    } else {
-        layer_off(_ADJUST);
-    }
-}
-```
-
-Example code after change:
-
-```c
-bool dip_switch_update_kb(uint8_t index, bool active) {
-    if !(dip_switch_update_user(index, active)) { return false; }
-    return true;
-}
-
-bool dip_switch_update_user(uint8_t index, bool active) {
-    switch (index) {
-        case 0:
-            if(active) { audio_on(); } else { audio_off(); }
-            break;
-    }
-    return true; // Returning true allows keyboard code to execute, false will tell the keyboard code "I've already handled it".
-}
-
-bool dip_switch_update_mask_kb(uint32_t state) {
-    if (!dip_switch_update_mask_user(state)) { return false; }
-    return true;
-}
-
-bool dip_switch_update_mask_user(uint32_t state) {
-    if (state & (1UL<<0) && state & (1UL<<1)) {
-        layer_on(_ADJUST); // C on esc
-    } else {
-        layer_off(_ADJUST);
-    }
-    return true; // Returning true allows keyboard code to execute, false will tell the keyboard code "I've already handled it".
-}
-```
-
-## Notable core changes :id=notable-core
-
-### Split transport improvements :id=split-transport-improvements
-
-Split keyboards gained a significant amount of improvements during this breaking changes cycle, specifically:
-
-* Extensible split data sync ([#11930](https://github.com/qmk/qmk_firmware/pull/11930)) -- rewritten data sharing between sides, allowing for data transfer only when required, as well as enabling keyboards and keymaps to define their own shared data.
-* Full-duplex ARM USART split ([#13081](https://github.com/qmk/qmk_firmware/pull/13081)) -- adds to the previous half-duplex driver and now allows for full-duplex support on ARM.
-* Make solo half of split keyboards (more) usable. ([#13523](https://github.com/qmk/qmk_firmware/pull/13523)) -- allows the slave to be disconnected, enabling one-handed use.
-* Switch split_common to CRC subsystem ([#13418](https://github.com/qmk/qmk_firmware/pull/13418))
-
-!> If you're updating your split keyboard, you will need to flash both sides of the split with the your firmware.
-
-### Teensy 4.x support ([#13056](https://github.com/qmk/qmk_firmware/pull/13056), [#13076](https://github.com/qmk/qmk_firmware/pull/13076), [#13077](https://github.com/qmk/qmk_firmware/pull/13077)) :id=teensy-4-x-support
-
-Updated ChibiOS and ChibiOS-Contrib, which brought in support for Teensy 4.x dev boards, running NXP i.MX1062.
-
-### Data Driven Improvements ([#13366](https://github.com/qmk/qmk_firmware/pull/13366))
-
-QMK's pursuit of data-driven keyboards has progressed, allowing substantially more configurable options to be specified in `info.json`.
-
-#### Tags
-
-Tags will let you categorize your keyboard, and will be used in the future to allow browsing and sorting through keyboards in QMK. Tags are free-form text identifiers that identify attributes about your keyboard. To add tags you simply add a `tags` key to your `info.json`:
-
-    "tags": ["tkl", "backlight", "encoder"]
-
-#### Dot Notation
-
-With this release we are moving towards using JSON dot notation in more places. For example, when using `qmk info -f text`:
-
-```
-$ qmk info -f text -kb clueboard/card
-  bootloader: atmel-dfu
-  debounce: 20
-  diode_direction: ROW2COL
-  features.audio: True
-  features.backlight: True
-  features.bluetooth: False
-  features.bootmagic: False
-  features.command: True
-  features.console: True
-  features.extrakey: True
-  features.lto: True
-  features.midi: False
-  features.mousekey: True
-  features.nkro: False
-  features.rgblight: True
-  features.unicode: False
-  height: 8
-  keyboard_folder: clueboard/card
-  keyboard_name: Cluecard
-  layout_aliases.LAYOUT: LAYOUT_all
-  layouts: LAYOUT_all
-  maintainer: skullydazed
-  manufacturer: Clueboard
-  matrix_pins.cols: F1, F6, F7
-  matrix_pins.rows: B4, F0, F4, F5
-  platform: unknown
-  processor: atmega32u4
-  processor_type: avr
-  protocol: LUFA
-  rgblight.brightness_steps: 17
-  rgblight.hue_steps: 10
-  rgblight.led_count: 4
-  rgblight.pin: E6
-  rgblight.saturation_steps: 17
-  split.transport.protocol: serial
-  usb.device_ver: 0x0001
-  usb.pid: 0x2330
-  usb.vid: 0xC1ED
-  width: 10
-```
-
-#### New configuration keys
-
-We've added dozens of new keys to `info.json` so that you can configure more than ever without writing a single line of code. A quick overview of the new items you can configure:
-
-* `audio.pins`, `audio.voices`
-* `backlight.breathing`, `backlight.breathing_period`, `backlight.levels`, `backlight.pin`,
-* `bluetooth.driver`, `bluetooth.lto`
-* `bootloader_instructions`
-* `build.debounce_type`, `build.firmware_format`, `build.lto`
-* `combo.count`, `combo.term`
-* `leader_key.timing`, `leader_key.strict_processing`, `leader_key.timeout`
-* `matrix.custom`, `matrix.custom_lite`, `matrix.ghost`, `matrix.io_delay`
-* `mouse_key.enabled`, `mouse_key.delay`, `mouse_key.interval`, `mouse_key.max_speed`, `mouse_key.time_to_max`, `mouse_key.wheel_delay`
-* `oneshot.tap_toggle`, `oneshot.timeout`
-* `rgblight.layers.blink`, `rgblight.layers.enabled`, `rgblight.layers.max`, `rgblight.layers.override_rgb`, `rgblight.rgbw`
-* `split.enabled`, `split.matrix_grid`, `split.matrix_pins`, `split.main`, `split.soft_serial_pin`, `split.soft_serial_speed`, `split.transport.protocol`, `split.transport.sync_matrix_state`, `split.transport.sync_modifiers`, `split.usb_detect`
-* `tapping.force_hold`, `tapping.force_hold_per_key`, `tapping.ignore_mod_tap_interrupt`, `tapping.ignore_mod_tap_interrupt_per_key`, `tapping.permissive_hold`, `tapping.permissive_hold_per_key`, `tapping.retro`, `tapping.retro_per_key`, `tapping.term`, `tapping.term_per_key`, `tapping.toggle`
-* `usb.force_nkro`, `usb.max_power`, `usb.no_startup_check`, `usb.polling_interval`, `usb.shared_endpoint.keyboard`, `usb.shared_endpoint.mouse`, `usb.suspend_wakeup_delay`, `usb.wait_for`
-* `qmk.keys_per_scan`, `qmk.tap_keycode_delay`, `qmk.tap_capslock_delay`
-
-### Codebase restructure and cleanup :id=codebase-restructure
-
-QMK was originally based on TMK, and has grown in size considerably since its first inception. To keep moving things forward, restructure of some of the core areas of the code is needed to support new concepts and new hardware, and progress is happening along those lines:
-
-* Move RGBLight code into its own folder ([#13312](https://github.com/qmk/qmk_firmware/pull/13312))
-* Migrate platform independent code from tmk_core -> quantum ([#13673](https://github.com/qmk/qmk_firmware/pull/13673))
-* matrix_scan_x -> x_task ([#13748](https://github.com/qmk/qmk_firmware/pull/13748))
-* Move some led drivers to common folder ([#13749](https://github.com/qmk/qmk_firmware/pull/13749))
-* Move chibios board files to allow tmk_core platform migration ([#13777](https://github.com/qmk/qmk_firmware/pull/13777))
-* Begin to carve out platform/protocol API - Single main loop ([#13843](https://github.com/qmk/qmk_firmware/pull/13843))
-* Relocate platform specific drivers ([#13894](https://github.com/qmk/qmk_firmware/pull/13894))
-* Move all the flash logic from tmk_core ([#13927](https://github.com/qmk/qmk_firmware/pull/13927))
-* Move USB Host Shield and Arduino core to `lib/` ([#13973](https://github.com/qmk/qmk_firmware/pull/13973))
-* Unify behaviour of wait on AVR ([#14025](https://github.com/qmk/qmk_firmware/pull/14025))
-* Move nix folder alongside vagrant ([#14132](https://github.com/qmk/qmk_firmware/pull/14132))
-* Align some quantum sub-directories ([#14134](https://github.com/qmk/qmk_firmware/pull/14134))
-
----
-
-## Full changelist
-
-Core:
-* Arm ps2 mouse interrupt ([#6490](https://github.com/qmk/qmk_firmware/pull/6490))
-* Process combos earlier & overlapping combos ([#8591](https://github.com/qmk/qmk_firmware/pull/8591))
-* Swap buttons on PS2 Mouse/Trackball ([#9205](https://github.com/qmk/qmk_firmware/pull/9205))
-* Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys ([#9404](https://github.com/qmk/qmk_firmware/pull/9404))
-* add yaml_build_options target ([#10533](https://github.com/qmk/qmk_firmware/pull/10533))
-* Warn when building a board that uses arm_atsam ([#10904](https://github.com/qmk/qmk_firmware/pull/10904))
-* Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422))
-* Refactor `quantum/command.{c,h}` for code size & {read,maintain}ability ([#11842](https://github.com/qmk/qmk_firmware/pull/11842))
-* Extensible split data sync ([#11930](https://github.com/qmk/qmk_firmware/pull/11930))
-* Move print/debug files to quantum ([#12069](https://github.com/qmk/qmk_firmware/pull/12069))
-* Unconditionally call led_init_ports ([#12116](https://github.com/qmk/qmk_firmware/pull/12116))
-* Support using a timer for wait_us() on ChibiOS-based boards ([#12211](https://github.com/qmk/qmk_firmware/pull/12211))
-* Add support for NO_PIN to all matrix types ([#12238](https://github.com/qmk/qmk_firmware/pull/12238))
-* Avoid 8-bit timer overflows in debounce algorithms ([#12240](https://github.com/qmk/qmk_firmware/pull/12240))
-* Add Per Key exclusions for Haptic Feedback ([#12386](https://github.com/qmk/qmk_firmware/pull/12386))
-* Steno combinedkeys ([#12538](https://github.com/qmk/qmk_firmware/pull/12538))
-* eeprom_stm32: implement high density wear leveling ([#12567](https://github.com/qmk/qmk_firmware/pull/12567))
-* eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. ([#12617](https://github.com/qmk/qmk_firmware/pull/12617))
-* Add CRC8 calculation subsystem to quantum ([#12641](https://github.com/qmk/qmk_firmware/pull/12641))
-* Limit saturation for RGB_MATRIX_JELLYBEAN_RAINDROPS ([#12669](https://github.com/qmk/qmk_firmware/pull/12669))
-* Add asym_eager_defer_pk debounce type ([#12689](https://github.com/qmk/qmk_firmware/pull/12689))
-* Include lib8tion.c into RGB/LED matrix build list ([#12699](https://github.com/qmk/qmk_firmware/pull/12699))
-* Add readPort() and some API to 'tmk_core/common/*/gpio.h' ([#12754](https://github.com/qmk/qmk_firmware/pull/12754))
-* add wait_cpuclock() macro for AVR and CPU_CLOCK macro ([#12755](https://github.com/qmk/qmk_firmware/pull/12755))
-* Trigger a wakeup after USB Reset on ChibiOS. ([#12831](https://github.com/qmk/qmk_firmware/pull/12831))
-* Add sync_timer support over serial_link (i.e. Ergodox Infinity) ([#12845](https://github.com/qmk/qmk_firmware/pull/12845))
-* Digitizer HID interface : absolute coordinates for mouse cursor ([#12851](https://github.com/qmk/qmk_firmware/pull/12851))
-* Add config.h and rules.mk support for data driven keymaps ([#12859](https://github.com/qmk/qmk_firmware/pull/12859))
-* Add alternate ldscript for STM32duino (F103xB) ([#12914](https://github.com/qmk/qmk_firmware/pull/12914))
-* `keymap_extras`: Remove deprecated defines ([#12949](https://github.com/qmk/qmk_firmware/pull/12949))
-* Retain brightness with lighting layers ([#13025](https://github.com/qmk/qmk_firmware/pull/13025))
-* Move optical sensor code to drivers folder ([#13044](https://github.com/qmk/qmk_firmware/pull/13044))
-* Change the prototype of matrix_output_unselect_delay() ([#13045](https://github.com/qmk/qmk_firmware/pull/13045))
-* Add weak refs on reading rows/cols. ([#13062](https://github.com/qmk/qmk_firmware/pull/13062))
-* Use single memcmp to determine if matrix changed. ([#13064](https://github.com/qmk/qmk_firmware/pull/13064))
-* Improve layer mask handling ([#13065](https://github.com/qmk/qmk_firmware/pull/13065))
-* mousekey: expose current report to users ([#13069](https://github.com/qmk/qmk_firmware/pull/13069))
-* ChibiOS SVN mirror script. ([#13070](https://github.com/qmk/qmk_firmware/pull/13070))
-* Added right vs left specific pin assignments for dip switch ([#13074](https://github.com/qmk/qmk_firmware/pull/13074))
-* make RESET key work with Teensy 4.x ([#13076](https://github.com/qmk/qmk_firmware/pull/13076))
-* wire up flash make target for Teensy 4.x ([#13077](https://github.com/qmk/qmk_firmware/pull/13077))
-* bump USB spec version in device descriptor to 2.0 ([#13078](https://github.com/qmk/qmk_firmware/pull/13078))
-* Unite half-duplex and full-duplex serial drivers ([#13081](https://github.com/qmk/qmk_firmware/pull/13081))
-* Add ST7565 LCD driver ([#13089](https://github.com/qmk/qmk_firmware/pull/13089))
-* `spi_master` Kinetis support ([#13098](https://github.com/qmk/qmk_firmware/pull/13098))
-* GMMK Pro RGB Support ([#13147](https://github.com/qmk/qmk_firmware/pull/13147))
-* Remove dfu-util arguments from mcu_selection ([#13150](https://github.com/qmk/qmk_firmware/pull/13150))
-* Add subcommand to generate version.h ([#13151](https://github.com/qmk/qmk_firmware/pull/13151))
-* Add oled_invert ([#13172](https://github.com/qmk/qmk_firmware/pull/13172))
-* ST7565 invert ([#13237](https://github.com/qmk/qmk_firmware/pull/13237))
-* RGB Matrix eeprom write limiting ([#13238](https://github.com/qmk/qmk_firmware/pull/13238))
-* Temporary disable of CRC ([#13252](https://github.com/qmk/qmk_firmware/pull/13252))
-* Move LED/RGB Matrix code into their own directories ([#13257](https://github.com/qmk/qmk_firmware/pull/13257))
-* Skip EEPROM writes once done. ([#13293](https://github.com/qmk/qmk_firmware/pull/13293))
-* Remove rgblight stubs ([#13302](https://github.com/qmk/qmk_firmware/pull/13302))
-* Allow settable SPI divisor for AW20216 driver, set default to 4 ([#13309](https://github.com/qmk/qmk_firmware/pull/13309))
-* Move RGBLight code into its own folder ([#13312](https://github.com/qmk/qmk_firmware/pull/13312))
-* Unify matrix for split common and regular matrix ([#13330](https://github.com/qmk/qmk_firmware/pull/13330))
-* Relocate RGB/HSV color defs to a more fitting place ([#13377](https://github.com/qmk/qmk_firmware/pull/13377))
-* Adds support for STM32L412xB, STM32L422xB. ([#13383](https://github.com/qmk/qmk_firmware/pull/13383))
-* Convert Dip Switch callbacks to boolean functions ([#13399](https://github.com/qmk/qmk_firmware/pull/13399))
-* Use string literals for `SERIAL_NUMBER` ([#13403](https://github.com/qmk/qmk_firmware/pull/13403))
-* Switch split_common to CRC subsystem ([#13418](https://github.com/qmk/qmk_firmware/pull/13418))
-* Improve 'show_build_options' target ([#13425](https://github.com/qmk/qmk_firmware/pull/13425))
-* AW20216 use register increment for framebuffer flushes ([#13430](https://github.com/qmk/qmk_firmware/pull/13430))
-* Allow invert of SPLIT_HAND_PIN logic ([#13433](https://github.com/qmk/qmk_firmware/pull/13433))
-* chibios: bootloader: use integer pointers as volatile ([#13450](https://github.com/qmk/qmk_firmware/pull/13450))
-* Refactor OLED to allow easy addition of other types ([#13454](https://github.com/qmk/qmk_firmware/pull/13454))
-* Dual RGB Matrix IS31FL3737 driver support to address #13442 ([#13457](https://github.com/qmk/qmk_firmware/pull/13457))
-* Enable g_is31_leds PROGMEM for RGB Matrix IS31FL3737 driver ([#13480](https://github.com/qmk/qmk_firmware/pull/13480))
-* Switch Ergodox Infinity over to split_common ([#13481](https://github.com/qmk/qmk_firmware/pull/13481))
-* Make solo half of split keyboards (more) usable. ([#13523](https://github.com/qmk/qmk_firmware/pull/13523))
-* Enable sync of OLED/ST7565 display on/off state on Splits ([#13542](https://github.com/qmk/qmk_firmware/pull/13542))
-* Revert "Add rgblight to RGB Matrix VPATH" ([#13559](https://github.com/qmk/qmk_firmware/pull/13559))
-* Move `SENDSTRING_BELL` code to `send_string.h` ([#13566](https://github.com/qmk/qmk_firmware/pull/13566))
-* Migrate platform independent code from tmk_core -> quantum ([#13673](https://github.com/qmk/qmk_firmware/pull/13673))
-* Avoid LTO conficts on arm_atsam ([#13676](https://github.com/qmk/qmk_firmware/pull/13676))
-* Allow for removal of hysteresis on 4x encoders ([#13698](https://github.com/qmk/qmk_firmware/pull/13698))
-* Port new_keyboard.sh to CLI ([#13706](https://github.com/qmk/qmk_firmware/pull/13706))
-* Align AW20216 driver ([#13712](https://github.com/qmk/qmk_firmware/pull/13712))
-* Haptic: driver-> feature ([#13713](https://github.com/qmk/qmk_firmware/pull/13713))
-* Add support for STM32F407x MCUs. ([#13718](https://github.com/qmk/qmk_firmware/pull/13718))
-* Remove legacy BACKLIGHT_CUSTOM_DRIVER option ([#13731](https://github.com/qmk/qmk_firmware/pull/13731))
-* Minor tidy up of key overrides ([#13747](https://github.com/qmk/qmk_firmware/pull/13747))
-* matrix_scan_x -> x_task ([#13748](https://github.com/qmk/qmk_firmware/pull/13748))
-* Move some led drivers to common folder ([#13749](https://github.com/qmk/qmk_firmware/pull/13749))
-* Allow for higher USB Polling rate on ATSAM boards ([#13755](https://github.com/qmk/qmk_firmware/pull/13755))
-* Rgb matrix/enable modes explicitly ([#13758](https://github.com/qmk/qmk_firmware/pull/13758))
-* Move chibios board files to allow tmk_core platform migration ([#13777](https://github.com/qmk/qmk_firmware/pull/13777))
-* __flash? ([#13799](https://github.com/qmk/qmk_firmware/pull/13799))
-* `--parallel` improvements ([#13800](https://github.com/qmk/qmk_firmware/pull/13800))
-* Speed up pimoroni trackball driver ([#13823](https://github.com/qmk/qmk_firmware/pull/13823))
-* Add a toggle key for GUI On/Off in Magic feature ([#13830](https://github.com/qmk/qmk_firmware/pull/13830))
-* Begin to carve out platform/protocol API - Single main loop ([#13843](https://github.com/qmk/qmk_firmware/pull/13843))
-* Remove Full Bootmagic ([#13846](https://github.com/qmk/qmk_firmware/pull/13846))
-* Remove backwards compatibility of debounce names ([#13877](https://github.com/qmk/qmk_firmware/pull/13877))
-* Relocate platform specific drivers ([#13894](https://github.com/qmk/qmk_firmware/pull/13894))
-* Remove ONEHAND_ENABLE ([#13920](https://github.com/qmk/qmk_firmware/pull/13920))
-* Move all the flash logic from tmk_core ([#13927](https://github.com/qmk/qmk_firmware/pull/13927))
-* adding uf2 flash support for blackpill 401 ([#13968](https://github.com/qmk/qmk_firmware/pull/13968))
-* Unify behaviour of wait on AVR ([#14025](https://github.com/qmk/qmk_firmware/pull/14025))
-* Add qmk-hid bootloader detection support to `qmk console` ([#14038](https://github.com/qmk/qmk_firmware/pull/14038))
-* Align DIP_SWITCH_PINS_RIGHT implementation with encoders ([#14079](https://github.com/qmk/qmk_firmware/pull/14079))
-* Tidy up quantum.c now some of tmk_core has been merged ([#14083](https://github.com/qmk/qmk_firmware/pull/14083))
-* Improve pmw3360 sensor and make it more hardware agnostic ([#14097](https://github.com/qmk/qmk_firmware/pull/14097))
-* Move nix folder alongside vagrant ([#14132](https://github.com/qmk/qmk_firmware/pull/14132))
-* Align some quantum sub-directories ([#14134](https://github.com/qmk/qmk_firmware/pull/14134))
-* Revert 14083 && 14144 ([#14150](https://github.com/qmk/qmk_firmware/pull/14150))
-
-CLI:
-* allow LINE_PINxx for Teensy 4.x pins ([#13247](https://github.com/qmk/qmk_firmware/pull/13247))
-* Remove the redundant pin name validation ([#13251](https://github.com/qmk/qmk_firmware/pull/13251))
-* Move all our CLI file formatters to the format dir ([#13296](https://github.com/qmk/qmk_firmware/pull/13296))
-* Refactor doctor.py into a directory ([#13298](https://github.com/qmk/qmk_firmware/pull/13298))
-* Add git and venv info to doctor's output ([#13405](https://github.com/qmk/qmk_firmware/pull/13405))
-* Matrix consistency check ([#13470](https://github.com/qmk/qmk_firmware/pull/13470))
-* Remove references to info.json `width` and `height` in CLI ([#13728](https://github.com/qmk/qmk_firmware/pull/13728))
-* Make `qmk doctor` more lenient about system config ([#13804](https://github.com/qmk/qmk_firmware/pull/13804))
-* Defer the expensive search for layout macros until info.json has been processed ([#14007](https://github.com/qmk/qmk_firmware/pull/14007))
-
-Submodule updates:
-* Update ChibiOS, ChibiOS-Contrib. ([#13056](https://github.com/qmk/qmk_firmware/pull/13056))
-* Update LUFA (18-07-2021) and add QMK-HID Bootloader support ([#13588](https://github.com/qmk/qmk_firmware/pull/13588))
-* Update LUFA Submodule (2021-07-30) ([#13819](https://github.com/qmk/qmk_firmware/pull/13819))
-* Bump gtest ([#13885](https://github.com/qmk/qmk_firmware/pull/13885))
-* Update ChibiOS-Contrib, mirroring script. ([#13896](https://github.com/qmk/qmk_firmware/pull/13896))
-* Move USB Host Shield and Arduino core to `lib/` ([#13973](https://github.com/qmk/qmk_firmware/pull/13973))
-
-Keyboards:
-* Migrate keyboards using uGFX to LED_MATRIX ([#9657](https://github.com/qmk/qmk_firmware/pull/9657))
-* Remove MIDI Configuration boilerplate ([#11151](https://github.com/qmk/qmk_firmware/pull/11151))
-* manyboard macro ([#11896](https://github.com/qmk/qmk_firmware/pull/11896))
-* Moved tokyo60/ into tokyokeyboard/tokyo60/. ([#12023](https://github.com/qmk/qmk_firmware/pull/12023))
-* Organize KPrepublic, K.T.E.C, xiudi boards into directories ([#12159](https://github.com/qmk/qmk_firmware/pull/12159))
-* Add Durgod Taurus K310 keyboard ([#12314](https://github.com/qmk/qmk_firmware/pull/12314))
-* add support for m65 and simple 5x13 ortholinear ([#12315](https://github.com/qmk/qmk_firmware/pull/12315))
-* Relocalize and Update p1800fl ([#12425](https://github.com/qmk/qmk_firmware/pull/12425))
-* GameBuddy v1.M ([#12637](https://github.com/qmk/qmk_firmware/pull/12637))
-* Add mechlovin9 rev2 PCB ([#12767](https://github.com/qmk/qmk_firmware/pull/12767))
-* Add RGB matrix support for Kyria ([#12789](https://github.com/qmk/qmk_firmware/pull/12789))
-* RGB Matrix working for Sofle RGB ([#12861](https://github.com/qmk/qmk_firmware/pull/12861))
-* Add Durgod Hades, Galaxy and Venus Keyboards ([#12893](https://github.com/qmk/qmk_firmware/pull/12893))
-* kint36: set correct EEPROM size ([#12946](https://github.com/qmk/qmk_firmware/pull/12946))
-* Updated encoder_update_user on my keymap to follow the new signature on quantum ([#13152](https://github.com/qmk/qmk_firmware/pull/13152))
-* Add Creator Pro by SergioPoverony ([#13154](https://github.com/qmk/qmk_firmware/pull/13154))
-* Use the new ST7565 driver on Ergodox Infinity ([#13165](https://github.com/qmk/qmk_firmware/pull/13165))
-* Refactor atom47 and add rev4 and rev5 ([#13201](https://github.com/qmk/qmk_firmware/pull/13201))
-* Add Bakeneko65 V3 and revision folders ([#13228](https://github.com/qmk/qmk_firmware/pull/13228))
-* Keyboards/RGBKB/Mün ([#13239](https://github.com/qmk/qmk_firmware/pull/13239))
-* Optimize our jsonschema by using refs ([#13271](https://github.com/qmk/qmk_firmware/pull/13271))
-* Handwired/Stream_Cheap/2x4: Add via support ([#13297](https://github.com/qmk/qmk_firmware/pull/13297))
-* ez_maker/directpins for easy one-offs in qmk_configurator ([#13321](https://github.com/qmk/qmk_firmware/pull/13321))
-* add kinT kinesis keyboard controller (kint41 variant) ([#13333](https://github.com/qmk/qmk_firmware/pull/13333))
-* Error log cleanup ([#13349](https://github.com/qmk/qmk_firmware/pull/13349))
-* Drashna's split updates ([#13350](https://github.com/qmk/qmk_firmware/pull/13350))
-* Migrate SHIFT_ESC and RGB `fn_actions` to Grave Escape and RGB keycodes ([#13360](https://github.com/qmk/qmk_firmware/pull/13360))
-* Add a lot more data to info.json ([#13366](https://github.com/qmk/qmk_firmware/pull/13366))
-* Remove `API_SYSEX_ENABLE`s from rules.mk ([#13389](https://github.com/qmk/qmk_firmware/pull/13389))
-* gmmk/pro/mike1808 keymap ([#13398](https://github.com/qmk/qmk_firmware/pull/13398))
-* Remove deprecated callbacks for encoders and dip switches ([#13404](https://github.com/qmk/qmk_firmware/pull/13404))
-* first pass: matrix consistency improvements ([#13471](https://github.com/qmk/qmk_firmware/pull/13471))
-* Migrate more `fn_actions` stuff ([#13502](https://github.com/qmk/qmk_firmware/pull/13502))
-* add simple gmmk pro macos keymap with rgb ([#13504](https://github.com/qmk/qmk_firmware/pull/13504))
-* move volcano660 to ilumkb folder ([#13550](https://github.com/qmk/qmk_firmware/pull/13550))
-* Valor Rev 2 ([#13551](https://github.com/qmk/qmk_firmware/pull/13551))
-* Split GMMK Pro PCBs into separate revisions ([#13570](https://github.com/qmk/qmk_firmware/pull/13570))
-* Remove the vision_division keyboard ([#13571](https://github.com/qmk/qmk_firmware/pull/13571))
-* Develop - Change uint32_t to layer_state_t ([#13596](https://github.com/qmk/qmk_firmware/pull/13596))
-* Develop - DC01 left ([#13597](https://github.com/qmk/qmk_firmware/pull/13597))
-* Created "paddlegame" keymap ([#13629](https://github.com/qmk/qmk_firmware/pull/13629))
-* Add timer_avr to includes for broken builds ([#13641](https://github.com/qmk/qmk_firmware/pull/13641))
-* Disable console by default on all Keebio boards ([#13649](https://github.com/qmk/qmk_firmware/pull/13649))
-* Enable LTO by default on BastardKB Scylla ([#13664](https://github.com/qmk/qmk_firmware/pull/13664))
-* Reduce compile size for dz60rgb v2.1 ([#13680](https://github.com/qmk/qmk_firmware/pull/13680))
-* Clean up remaining RGB_DISABLE_WHEN_USB_SUSPENDED defines ([#13689](https://github.com/qmk/qmk_firmware/pull/13689))
-* Remove some legacy files ([#13715](https://github.com/qmk/qmk_firmware/pull/13715))
-* [Keyboard Update] Change to L422 ([#13717](https://github.com/qmk/qmk_firmware/pull/13717))
-* Update kyria make path example ([#13720](https://github.com/qmk/qmk_firmware/pull/13720))
-* Drashna's Defaults cleanup ([#13722](https://github.com/qmk/qmk_firmware/pull/13722))
-* Reduce firmware size in prep for #12670 ([#13724](https://github.com/qmk/qmk_firmware/pull/13724))
-* Tidy up rgbkb/mun ([#13801](https://github.com/qmk/qmk_firmware/pull/13801))
-* Make default keymap for GMMK Pro reflect stock ([#13850](https://github.com/qmk/qmk_firmware/pull/13850))
-* Rework as per 9824 ([#13898](https://github.com/qmk/qmk_firmware/pull/13898))
-* Remove console from keebio via keyboards ([#13901](https://github.com/qmk/qmk_firmware/pull/13901))
-* Drashna split transport improvement ([#13905](https://github.com/qmk/qmk_firmware/pull/13905))
-* Copy GMMK Pro screw specs to ISO readme ([#13908](https://github.com/qmk/qmk_firmware/pull/13908))
-* Clean up remaining RGB_DISABLE_WHEN_USB_SUSPENDED defines Part 2 ([#13912](https://github.com/qmk/qmk_firmware/pull/13912))
-* Add andrebrait layout for GMMK Pro ([#13932](https://github.com/qmk/qmk_firmware/pull/13932))
-* Updated RGB Matrix suspend define part 3 ([#13954](https://github.com/qmk/qmk_firmware/pull/13954))
-* Improve andrebrait keymap ([#13985](https://github.com/qmk/qmk_firmware/pull/13985))
-* Drashna's Improve OLEDs and custom Split code ([#14063](https://github.com/qmk/qmk_firmware/pull/14063))
-* Kyria default reformat ([#14080](https://github.com/qmk/qmk_firmware/pull/14080))
-* Feature rich keymap for GMMK Pro (ANSI) ([#14120](https://github.com/qmk/qmk_firmware/pull/14120))
-
-Keyboard fixes:
-* Fix LED mapping for GMMK Pro ([#13189](https://github.com/qmk/qmk_firmware/pull/13189))
-* Fix up SplitKB keyboards ([#13511](https://github.com/qmk/qmk_firmware/pull/13511))
-* Keyboards/sol rev2 fix ([#13533](https://github.com/qmk/qmk_firmware/pull/13533))
-* Fix MATRIX_COLS for aeboards/constellation/rev2 ([#13633](https://github.com/qmk/qmk_firmware/pull/13633))
-* Fix errors with matrix_output_unselect_delay function calls ([#13645](https://github.com/qmk/qmk_firmware/pull/13645))
-* Fix default keymap for 0xCB 1337 keyboard ([#13646](https://github.com/qmk/qmk_firmware/pull/13646))
-* Fix Matrix Row number for ggkeyboards/genisis ([#13647](https://github.com/qmk/qmk_firmware/pull/13647))
-* Fix matrix issues with Promethium ([#13648](https://github.com/qmk/qmk_firmware/pull/13648))
-* Fix dc01/left so that it doesn't throw a warning ([#13653](https://github.com/qmk/qmk_firmware/pull/13653))
-* Remove broken, unmaintained converter/ibm_5291 ([#13658](https://github.com/qmk/qmk_firmware/pull/13658))
-* Quick hack to fix Astro65 board ([#13665](https://github.com/qmk/qmk_firmware/pull/13665))
-* Fix symmetric70_proto build break on develop branch ([#13667](https://github.com/qmk/qmk_firmware/pull/13667))
-* Fix matrix delay on Drop boards ([#13671](https://github.com/qmk/qmk_firmware/pull/13671))
-* Fix split matrix for sekigon grs 70ec ([#13672](https://github.com/qmk/qmk_firmware/pull/13672))
-* Fix type on pandora via keymap ([#13681](https://github.com/qmk/qmk_firmware/pull/13681))
-* Fix & clean up tronguylabs/m122_3270 ([#13684](https://github.com/qmk/qmk_firmware/pull/13684))
-* Fix up xd002 rgb keymaps ([#13685](https://github.com/qmk/qmk_firmware/pull/13685))
-* Dactyl Manuform cleanup ([#13686](https://github.com/qmk/qmk_firmware/pull/13686))
-* Fix Q1 change dip switch to bool ([#13687](https://github.com/qmk/qmk_firmware/pull/13687))
-* Fix compile size for the Merge UM70 via keymap ([#13690](https://github.com/qmk/qmk_firmware/pull/13690))
-* Fix compile size for the Lets Split Sockets via keymap ([#13691](https://github.com/qmk/qmk_firmware/pull/13691))
-* Fix Compile size on ungodly Launch Pad ([#13692](https://github.com/qmk/qmk_firmware/pull/13692))
-* dirty fix ([#13695](https://github.com/qmk/qmk_firmware/pull/13695))
-* Fix compile size for the Vitamins Included via keymap ([#13696](https://github.com/qmk/qmk_firmware/pull/13696))
-* Fix typo in Dactyl Manuform ([#13740](https://github.com/qmk/qmk_firmware/pull/13740))
-* Fix compile issues due to LED changes ([#13821](https://github.com/qmk/qmk_firmware/pull/13821))
-* Fix SRC include for matrix/m20add issi driver ([#13826](https://github.com/qmk/qmk_firmware/pull/13826))
-* fix develop branch move file ([#13832](https://github.com/qmk/qmk_firmware/pull/13832))
-* Fix knops keymaps ([#13872](https://github.com/qmk/qmk_firmware/pull/13872))
-* Switch Draculad to using WPM char hack ([#13886](https://github.com/qmk/qmk_firmware/pull/13886))
-* Fix up builds after #8591 ([#13900](https://github.com/qmk/qmk_firmware/pull/13900))
-* Fix matrix_output_unselect_delay for handwired/xealousbrown ([#13913](https://github.com/qmk/qmk_firmware/pull/13913))
-* Fixup rgb matrix config for KBD67 mkII boards ([#13931](https://github.com/qmk/qmk_firmware/pull/13931))
-* Fix compliation for ferris 0.2 bling ([#13937](https://github.com/qmk/qmk_firmware/pull/13937))
-* Fix some additional bootmagic settings ([#13979](https://github.com/qmk/qmk_firmware/pull/13979))
-* Fix default keymap for GMMK Pro Iso ([#13980](https://github.com/qmk/qmk_firmware/pull/13980))
-* Fixup Ungodly Launch Pad config ([#13992](https://github.com/qmk/qmk_firmware/pull/13992))
-* Fix errors that have cropped up in develop ([#14005](https://github.com/qmk/qmk_firmware/pull/14005))
-* Fix wait_us overflow in matrix for dactyl based boards ([#14039](https://github.com/qmk/qmk_firmware/pull/14039))
-* Fixup Neson Design N6 ISSI includes ([#14045](https://github.com/qmk/qmk_firmware/pull/14045))
-* Fixup `massdrop/alt`, `cest73/tkm`. ([#14048](https://github.com/qmk/qmk_firmware/pull/14048))
-* fix helix:fraanrosi compile error caused by #13677. ([#14061](https://github.com/qmk/qmk_firmware/pull/14061))
-* Fix compile issues for Tractyl Manuform ([#14105](https://github.com/qmk/qmk_firmware/pull/14105))
-* Disable Console on Keebio Quefrency ([#14108](https://github.com/qmk/qmk_firmware/pull/14108))
-* Fixed GMMK Pro -> stickandgum keymap readme.md ([#14123](https://github.com/qmk/qmk_firmware/pull/14123))
-* Drashna keymap fixups ([#14140](https://github.com/qmk/qmk_firmware/pull/14140))
-* fix ([#14142](https://github.com/qmk/qmk_firmware/pull/14142))
-* Fix merge artifacts ([#14146](https://github.com/qmk/qmk_firmware/pull/14146))
-* Update readme files ([#14172](https://github.com/qmk/qmk_firmware/pull/14172))
-
-Others:
-* Add examples to RGB Matrix Indicators docs ([#12797](https://github.com/qmk/qmk_firmware/pull/12797))
-
-Bugs:
-* Fix Indicator LED issues ([#12097](https://github.com/qmk/qmk_firmware/pull/12097))
-* Fixing incorrect keymap build when switching between multiple keymap.jsons ([#12632](https://github.com/qmk/qmk_firmware/pull/12632))
-* Fix LED Hit Counter for LED/RGB Matrix ([#12674](https://github.com/qmk/qmk_firmware/pull/12674))
-* ChibiOS fix O3 and LTO breakage of extra keys and joystick ([#12819](https://github.com/qmk/qmk_firmware/pull/12819))
-* Remove the #10088 hotfix for Teensy 3.1-like Input:Club keyboards ([#12870](https://github.com/qmk/qmk_firmware/pull/12870))
-* Fix firmware size check with avr-libc 1:2.0.0+Atmel3.6.2-1.1 (Debian bullseye) ([#12951](https://github.com/qmk/qmk_firmware/pull/12951))
-* Fix RGB/LED Suspend defines ([#13146](https://github.com/qmk/qmk_firmware/pull/13146))
-* Fix overrun in st7565_write_raw when not at (0, 0) ([#13209](https://github.com/qmk/qmk_firmware/pull/13209))
-* Upgrades Vagrant box to Debian 10 to fix Docker build error on Debian 9. ([#13236](https://github.com/qmk/qmk_firmware/pull/13236))
-* Fix issues with VIA EEPROM init and bring in line with eeconfig functionality ([#13243](https://github.com/qmk/qmk_firmware/pull/13243))
-* Fix CRC for AVR and enable again. ([#13253](https://github.com/qmk/qmk_firmware/pull/13253))
-* Fix linker error when rgblight and RGB Matrix are both enabled ([#13304](https://github.com/qmk/qmk_firmware/pull/13304))
-* Fix building layouts from JSON ([#13310](https://github.com/qmk/qmk_firmware/pull/13310))
-* Add rgblight to RGB Matrix VPATH ([#13371](https://github.com/qmk/qmk_firmware/pull/13371))
-* Fix two out of bounds accesses from #13330. ([#13525](https://github.com/qmk/qmk_firmware/pull/13525))
-* Fixes for clang not being able to run unit tests ([#13546](https://github.com/qmk/qmk_firmware/pull/13546))
-* Fixup Audio startup and add to documents ([#13606](https://github.com/qmk/qmk_firmware/pull/13606))
-* CLI/Docs: Fix the format commands' name ([#13668](https://github.com/qmk/qmk_firmware/pull/13668))
-* Disables rgblight twinkle by default. ([#13677](https://github.com/qmk/qmk_firmware/pull/13677))
-* Fix typo in dip switch example ([#13688](https://github.com/qmk/qmk_firmware/pull/13688))
-* docs/cli_commands: fix typo ([#13697](https://github.com/qmk/qmk_firmware/pull/13697))
-* Include gpio.h in solenoid driver for GPIO Control functions ([#13716](https://github.com/qmk/qmk_firmware/pull/13716))
-* Fix pimoroni trackball read address ([#13810](https://github.com/qmk/qmk_firmware/pull/13810))
-* Fix Key Override includes ([#13831](https://github.com/qmk/qmk_firmware/pull/13831))
-* Fix alignment of USB out report buffer 2 -> 4 ([#13838](https://github.com/qmk/qmk_firmware/pull/13838))
-* Fix compilation issue. ([#13926](https://github.com/qmk/qmk_firmware/pull/13926))
-* Fix `combo_disable` ([#13988](https://github.com/qmk/qmk_firmware/pull/13988))
-* Fix pmw3360 code to only output debug info if mouse debugging is enabled ([#13993](https://github.com/qmk/qmk_firmware/pull/13993))
-* Fix ifdefs for OLED split sync code ([#14017](https://github.com/qmk/qmk_firmware/pull/14017))
-* Various fixes from reorg of files ([#14051](https://github.com/qmk/qmk_firmware/pull/14051))
-* Fixup atsam builds. ([#14052](https://github.com/qmk/qmk_firmware/pull/14052))
-* Fix RGB/LED Matrix Suspend code ([#14084](https://github.com/qmk/qmk_firmware/pull/14084))
-* Fix issues with recent keymap.json changes ([#14089](https://github.com/qmk/qmk_firmware/pull/14089))
-* Fix LED Matrix suspend code ([#14090](https://github.com/qmk/qmk_firmware/pull/14090))
-* Fix up compilation issues. ([#14095](https://github.com/qmk/qmk_firmware/pull/14095))
-* Fix copypasta issue with pmw3360 sensor config ([#14106](https://github.com/qmk/qmk_firmware/pull/14106))
-* Fix typo ([#14118](https://github.com/qmk/qmk_firmware/pull/14118))
-* Fix bootloadHID comments breaking :flash ([#14133](https://github.com/qmk/qmk_firmware/pull/14133))
-* Fix Mouse Shared EP functionality ([#14136](https://github.com/qmk/qmk_firmware/pull/14136))
-* Short term bodge for firmware size bloat ([#14144](https://github.com/qmk/qmk_firmware/pull/14144))
-* Move to correct location ([#14171](https://github.com/qmk/qmk_firmware/pull/14171))

docs/_summary.md

@@ -19,7 +19,6 @@
   * [Overview](newbs_building_firmware_configurator.md)
   * [Step by Step](configurator_step_by_step.md)
   * [Troubleshooting](configurator_troubleshooting.md)
-  * [Architecture](configurator_architecture.md)
   * QMK API
     * [Overview](api_overview.md)
     * [API Documentation](api_docs.md)
@@ -30,13 +29,11 @@
     * [Overview](cli.md)
     * [Configuration](cli_configuration.md)
     * [Commands](cli_commands.md)
-    * [Tab Completion](cli_tab_complete.md)
 
 * Using QMK
   * Guides
     * [Customizing Functionality](custom_quantum_functions.md)
     * [Driver Installation with Zadig](driver_installation_zadig.md)
-    * [Easy Maker for One Offs](easy_maker.md)
     * [Keymap Overview](keymap.md)
     * Development Environments
       * [Docker Guide](getting_started_docker.md)
@@ -62,7 +59,6 @@
     * [Language-Specific Keycodes](reference_keymap_extras.md)
     * [Modifier Keys](feature_advanced_keycodes.md)
     * [Quantum Keycodes](quantum_keycodes.md)
-    * [Magic Keycodes](keycodes_magic.md)
 
   * Advanced Keycodes
     * [Command](feature_command.md)
@@ -80,7 +76,6 @@
     * [Combos](feature_combo.md)
     * [Debounce API](feature_debounce_type.md)
     * [Key Lock](feature_key_lock.md)
-    * [Key Overrides](feature_key_overrides.md)
     * [Layers](feature_layers.md)
     * [One Shot Keys](one_shot_keys.md)
     * [Pointing Device](feature_pointing_device.md)
@@ -97,7 +92,6 @@
   * Hardware Features
     * Displays
       * [HD44780 LCD Controller](feature_hd44780.md)
-      * [ST7565 LCD Driver](feature_st7565.md)
       * [OLED Driver](feature_oled_driver.md)
     * Lighting
       * [Backlight](feature_backlight.md)
@@ -106,15 +100,13 @@
       * [RGB Matrix](feature_rgb_matrix.md)
     * [Audio](feature_audio.md)
     * [Bluetooth](feature_bluetooth.md)
-    * [Bootmagic Lite](feature_bootmagic.md)
+    * [Bootmagic](feature_bootmagic.md)
     * [Custom Matrix](custom_matrix.md)
-    * [Digitizer](feature_digitizer.md)
     * [DIP Switch](feature_dip_switch.md)
     * [Encoders](feature_encoders.md)
     * [Haptic Feedback](feature_haptic_feedback.md)
     * [Joystick](feature_joystick.md)
     * [LED Indicators](feature_led_indicators.md)
-    * [MIDI](feature_midi.md)
     * [Proton C Conversion](proton_c_conversion.md)
     * [PS/2 Mouse](feature_ps2_mouse.md)
     * [Split Keyboard](feature_split_keyboard.md)
@@ -127,8 +119,12 @@
   * Breaking Changes
     * [Overview](breaking_changes.md)
     * [My Pull Request Was Flagged](breaking_changes_instructions.md)
-    * [Most Recent ChangeLog](ChangeLog/20210529.md "QMK v0.13.0 - 2021 May 29")
-    * [Past Breaking Changes](breaking_changes_history.md)
+    * History
+      * [2020 Nov 28](ChangeLog/20201128.md)
+      * [2020 Aug 29](ChangeLog/20200829.md)
+      * [2020 May 30](ChangeLog/20200530.md)
+      * [2020 Feb 29](ChangeLog/20200229.md)
+      * [2019 Aug 30](ChangeLog/20190830.md)
 
   * C Development
     * [ARM Debugging Guide](arm_debugging.md)
@@ -137,13 +133,11 @@
     * [Compatible Microcontrollers](compatible_microcontrollers.md)
     * [Drivers](hardware_drivers.md)
       * [ADC Driver](adc_driver.md)
-      * [Audio Driver](audio_driver.md)
       * [I2C Driver](i2c_driver.md)
       * [SPI Driver](spi_driver.md)
       * [WS2812 Driver](ws2812_driver.md)
       * [EEPROM Driver](eeprom_driver.md)
       * ['serial' Driver](serial_driver.md)
-      * [UART Driver](uart_driver.md)
     * [GPIO Controls](internals_gpio_control.md)
     * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
 
@@ -165,7 +159,6 @@
     * [Contributing to QMK](contributing.md)
     * [Translating the QMK Docs](translating.md)
     * [Config Options](config_options.md)
-    * [Data Driven Configuration](data_driven_config.md)
     * [Make Documentation](getting_started_make_guide.md)
     * [Documentation Best Practices](documentation_best_practices.md)
     * [Documentation Templates](documentation_templates.md)

docs/adc_driver.md

@@ -47,79 +47,73 @@ Note that some of these pins are doubled-up on ADCs with the same channel. This
 
 Also note that the F0 and F3 use different numbering schemes. The F0 has a single ADC and the channels are 0-indexed, whereas the F3 has 4 ADCs and the channels are 1-indexed. This is because the F0 uses the `ADCv1` implementation of the ADC, whereas the F3 uses the `ADCv3` implementation.
 
-|ADC|Channel|STM32F0xx|STM32F1xx|STM32F3xx|STM32F4xx|
-|---|-------|---------|---------|---------|---------|
-|1  |0      |`A0`     |`A0`     |         |`A0`     |
-|1  |1      |`A1`     |`A1`     |`A0`     |`A1`     |
-|1  |2      |`A2`     |`A2`     |`A1`     |`A2`     |
-|1  |3      |`A3`     |`A3`     |`A2`     |`A3`     |
-|1  |4      |`A4`     |`A4`     |`A3`     |`A4`     |
-|1  |5      |`A5`     |`A5`     |`F4`     |`A5`     |
-|1  |6      |`A6`     |`A6`     |`C0`     |`A6`     |
-|1  |7      |`A7`     |`A7`     |`C1`     |`A7`     |
-|1  |8      |`B0`     |`B0`     |`C2`     |`B0`     |
-|1  |9      |`B1`     |`B1`     |`C3`     |`B1`     |
-|1  |10     |`C0`     |`C0`     |`F2`     |`C0`     |
-|1  |11     |`C1`     |`C1`     |         |`C1`     |
-|1  |12     |`C2`     |`C2`     |         |`C2`     |
-|1  |13     |`C3`     |`C3`     |         |`C3`     |
-|1  |14     |`C4`     |`C4`     |         |`C4`     |
-|1  |15     |`C5`     |`C5`     |         |`C5`     |
-|1  |16     |         |         |         |         |
-|2  |0      |         |`A0`¹    |         |`A0`²    |
-|2  |1      |         |`A1`¹    |`A4`     |`A1`²    |
-|2  |2      |         |`A2`¹    |`A5`     |`A2`²    |
-|2  |3      |         |`A3`¹    |`A6`     |`A3`²    |
-|2  |4      |         |`A4`¹    |`A7`     |`A4`²    |
-|2  |5      |         |`A5`¹    |`C4`     |`A5`²    |
-|2  |6      |         |`A6`¹    |`C0`     |`A6`²    |
-|2  |7      |         |`A7`¹    |`C1`     |`A7`²    |
-|2  |8      |         |`B0`¹    |`C2`     |`B0`²    |
-|2  |9      |         |`B1`¹    |`C3`     |`B1`²    |
-|2  |10     |         |`C0`¹    |`F2`     |`C0`²    |
-|2  |11     |         |`C1`¹    |`C5`     |`C1`²    |
-|2  |12     |         |`C2`¹    |`B2`     |`C2`²    |
-|2  |13     |         |`C3`¹    |         |`C3`²    |
-|2  |14     |         |`C4`¹    |         |`C4`²    |
-|2  |15     |         |`C5`¹    |         |`C5`²    |
-|2  |16     |         |         |         |         |
-|3  |0      |         |`A0`¹    |         |`A0`²    |
-|3  |1      |         |`A1`¹    |`B1`     |`A1`²    |
-|3  |2      |         |`A2`¹    |`E9`     |`A2`²    |
-|3  |3      |         |`A3`¹    |`E13`    |`A3`²    |
-|3  |4      |         |`F6`¹    |         |`F6`²    |
-|3  |5      |         |`F7`¹    |`B13`    |`F7`²    |
-|3  |6      |         |`F8`¹    |`E8`     |`F8`²    |
-|3  |7      |         |`F9`¹    |`D10`    |`F9`²    |
-|3  |8      |         |`F10`¹   |`D11`    |`F10`²   |
-|3  |9      |         |         |`D12`    |`F3`²    |
-|3  |10     |         |`C0`¹    |`D13`    |`C0`²    |
-|3  |11     |         |`C1`¹    |`D14`    |`C1`²    |
-|3  |12     |         |`C2`¹    |`B0`     |`C2`²    |
-|3  |13     |         |`C3`¹    |`E7`     |`C3`²    |
-|3  |14     |         |         |`E10`    |`F4`²    |
-|3  |15     |         |         |`E11`    |`F5`²    |
-|3  |16     |         |         |`E12`    |         |
-|4  |1      |         |         |`E14`    |         |
-|4  |2      |         |         |`E15`    |         |
-|4  |3      |         |         |`B12`    |         |
-|4  |4      |         |         |`B14`    |         |
-|4  |5      |         |         |`B15`    |         |
-|4  |6      |         |         |`E8`     |         |
-|4  |7      |         |         |`D10`    |         |
-|4  |8      |         |         |`D11`    |         |
-|4  |9      |         |         |`D12`    |         |
-|4  |10     |         |         |`D13`    |         |
-|4  |11     |         |         |`D14`    |         |
-|4  |12     |         |         |`D8`     |         |
-|4  |13     |         |         |`D9`     |         |
-|4  |14     |         |         |         |         |
-|4  |15     |         |         |         |         |
-|4  |16     |         |         |         |         |
-
-<sup>¹ As of ChibiOS 20.3.4, the ADC driver for STM32F1xx devices supports only ADC1, therefore any configurations involving ADC2 or ADC3 cannot actually be used. In particular, pins `F6`…`F10`, which are present at least on some STM32F103x[C-G] devices, cannot be used as ADC inputs because of this driver limitation.</sup>
-
-<sup>² Not all STM32F4xx devices have ADC2 and/or ADC3, therefore some configurations shown in this table may be unavailable; in particular, pins `F4`…`F10` cannot be used as ADC inputs on devices which do not have ADC3. Check the device datasheet to confirm which pin functions are supported.</sup>
+|ADC|Channel|STM32F0xx|STM32F3xx|
+|---|-------|---------|---------|
+|1  |0      |`A0`     |         |
+|1  |1      |`A1`     |`A0`     |
+|1  |2      |`A2`     |`A1`     |
+|1  |3      |`A3`     |`A2`     |
+|1  |4      |`A4`     |`A3`     |
+|1  |5      |`A5`     |`F4`     |
+|1  |6      |`A6`     |`C0`     |
+|1  |7      |`A7`     |`C1`     |
+|1  |8      |`B0`     |`C2`     |
+|1  |9      |`B1`     |`C3`     |
+|1  |10     |`C0`     |`F2`     |
+|1  |11     |`C1`     |         |
+|1  |12     |`C2`     |         |
+|1  |13     |`C3`     |         |
+|1  |14     |`C4`     |         |
+|1  |15     |`C5`     |         |
+|1  |16     |         |         |
+|2  |1      |         |`A4`     |
+|2  |2      |         |`A5`     |
+|2  |3      |         |`A6`     |
+|2  |4      |         |`A7`     |
+|2  |5      |         |`C4`     |
+|2  |6      |         |`C0`     |
+|2  |7      |         |`C1`     |
+|2  |8      |         |`C2`     |
+|2  |9      |         |`C3`     |
+|2  |10     |         |`F2`     |
+|2  |11     |         |`C5`     |
+|2  |12     |         |`B2`     |
+|2  |13     |         |         |
+|2  |14     |         |         |
+|2  |15     |         |         |
+|2  |16     |         |         |
+|3  |1      |         |`B1`     |
+|3  |2      |         |`E9`     |
+|3  |3      |         |`E13`    |
+|3  |4      |         |         |
+|3  |5      |         |         |
+|3  |6      |         |`E8`     |
+|3  |7      |         |`D10`    |
+|3  |8      |         |`D11`    |
+|3  |9      |         |`D12`    |
+|3  |10     |         |`D13`    |
+|3  |11     |         |`D14`    |
+|3  |12     |         |`B0`     |
+|3  |13     |         |`E7`     |
+|3  |14     |         |`E10`    |
+|3  |15     |         |`E11`    |
+|3  |16     |         |`E12`    |
+|4  |1      |         |`E14`    |
+|4  |2      |         |`B12`    |
+|4  |3      |         |`B13`    |
+|4  |4      |         |`B14`    |
+|4  |5      |         |`B15`    |
+|4  |6      |         |`E8`     |
+|4  |7      |         |`D10`    |
+|4  |8      |         |`D11`    |
+|4  |9      |         |`D12`    |
+|4  |10     |         |`D13`    |
+|4  |11     |         |`D14`    |
+|4  |12     |         |`D8`     |
+|4  |13     |         |`D9`     |
+|4  |14     |         |         |
+|4  |15     |         |         |
+|4  |16     |         |         |
 
 ## Functions
 
@@ -147,10 +141,10 @@ Also note that the F0 and F3 use different numbering schemes. The F0 has a singl
 
 The ARM implementation of the ADC has a few additional options that you can override in your own keyboards and keymaps to change how it operates. Please consult the corresponding `hal_adc_lld.h` in ChibiOS for your specific microcontroller for further documentation on your available options.
 
-|`#define`            |Type  |Default                                       |Description                                                                                                                                                                                                 |
-|---------------------|------|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-|`ADC_CIRCULAR_BUFFER`|`bool`|`false`                                       |If `true`, then the implementation will use a circular buffer.                                                                                                                                              |
-|`ADC_NUM_CHANNELS`   |`int` |`1`                                           |Sets the number of channels that will be scanned as part of an ADC operation. The current implementation only supports `1`.                                                                                 |
-|`ADC_BUFFER_DEPTH`   |`int` |`2`                                           |Sets the depth of each result. Since we are only getting a 10-bit result by default, we set this to 2 bytes so we can contain our one value. This could be set to 1 if you opt for an 8-bit or lower result.|
-|`ADC_SAMPLING_RATE`  |`int` |`ADC_SMPR_SMP_1P5`                            |Sets the sampling rate of the ADC. By default, it is set to the fastest setting.                                                                                                                            |
-|`ADC_RESOLUTION`     |`int` |`ADC_CFGR1_RES_10BIT` or `ADC_CFGR_RES_10BITS`|The resolution of your result. We choose 10 bit by default, but you can opt for 12, 10, 8, or 6 bit. Different MCUs use slightly different names for the resolution constants.                              |
+|`#define`            |Type  |Default              |Description                                                                                                                                                                                                 |
+|---------------------|------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|`ADC_CIRCULAR_BUFFER`|`bool`|`false`              |If `true`, then the implementation will use a circular buffer.                                                                                                                                              |
+|`ADC_NUM_CHANNELS`   |`int` |`1`                  |Sets the number of channels that will be scanned as part of an ADC operation. The current implementation only supports `1`.                                                                                 |
+|`ADC_BUFFER_DEPTH`   |`int` |`2`                  |Sets the depth of each result. Since we are only getting a 12-bit result by default, we set this to 2 bytes so we can contain our one value. This could be set to 1 if you opt for an 8-bit or lower result.|
+|`ADC_SAMPLING_RATE`  |`int` |`ADC_SMPR_SMP_1P5`   |Sets the sampling rate of the ADC. By default, it is set to the fastest setting.                                                                                                                            |
+|`ADC_RESOLUTION`     |`int` |`ADC_CFGR1_RES_12BIT`|The resolution of your result. We choose 12 bit by default, but you can opt for 12, 10, 8, or 6 bit.                                                                                                        |

docs/audio_driver.md

@@ -1,221 +0,0 @@
-# Audio Driver :id=audio-driver
-
-The [Audio feature](feature_audio.md) breaks the hardware specifics out into separate, exchangeable driver units, with a common interface to the audio-"core" - which itself handles playing songs and notes while tracking their progress in an internal state, initializing/starting/stopping the driver as needed.
-
-Not all MCUs support every available driver, either the platform-support is not there (yet?) or the MCU simply does not have the required hardware peripheral.
-
-
-## AVR :id=avr
-
-Boards built around an Atmega32U4 can use two sets of PWM capable pins, each driving a separate speaker.
-The possible configurations are:
-
-|              | Timer3      | Timer1       |
-|--------------|-------------|--------------|
-| one speaker  | C4,C5 or C6 |              |
-| one speaker  |             | B4, B5 or B7 |
-| two speakers | C4,C5 or C6 | B4, B5 or B7 |
-
-Currently there is only one/default driver for AVR based boards, which is automatically configured to:
-
-```make
-AUDIO_DRIVER = pwm_hardware
-```
-
-
-## ARM :id=arm
-
-For Arm based boards, QMK depends on ChibiOS - hence any MCU supported by the later is likely usable, as long as certain hardware peripherals are available.
-
-Supported wiring configurations, with their ChibiOS/MCU peripheral requirement are listed below;
-piezo speakers are marked with :one: for the first/primary and :two: for the secondary.
-
-  | driver       | GPTD6<br>Tim6                            | GPTD7<br>Tim7          | GPTD8<br>Tim8 | PWMD1<sup>1</sup><br>Tim1_Ch1 |
-  |--------------|------------------------------------------|------------------------|---------------|-------------------------------|
-  | dac_basic    | A4+DACD1 = :one:                         | A5+DACD2 = :one:       | state         |                               |
-  |              | A4+DACD1 = :one: + Gnd                   | A5+DACD2 = :two: + Gnd | state         |                               |
-  |              | A4+DACD1 = :two: + Gnd                   | A5+DACD2 = :one: + Gnd | state         |                               |
-  |              | A4+DACD1 = :one: + Gnd                   |                        | state         |                               |
-  |              |                                          | A5+DACD2 = :one: + Gnd | state         |                               |
-  | dac_additive | A4+DACD1 = :one: + Gnd                   |                        |               |                               |
-  |              | A5+DACD2 = :one: + Gnd                   |                        |               |                               |
-  |              | A4+DACD1 + A5+DACD2 = :one: <sup>2</sup> |                        |               |                               |
-  | pwm_software | state-update                             |                        |               | any = :one:                   |
-  | pwm hardware | state-update                             |                        |               | A8 = :one: <sup>3</sup>       |
-
-
-<sup>1</sup>: the routing and alternate functions for PWM differ sometimes between STM32 MCUs, if in doubt consult the data-sheet  
-<sup>2</sup>: one piezo connected to A4 and A5, with AUDIO_PIN_ALT_AS_NEGATIVE set  
-<sup>3</sup>: TIM1_CH1 = A8 on STM32F103C8, other combinations are possible, see Data-sheet. configured with: AUDIO_PWM_DRIVER and AUDIO_PWM_CHANNEL
-
-
-
-### DAC basic :id=dac-basic
-
-The default driver for ARM boards, in absence of an overriding configuration.
-This driver needs one Timer per enabled/used DAC channel, to trigger conversion; and a third timer to trigger state updates with the audio-core.
-
-Additionally, in the board config, you'll want to make changes to enable the DACs, GPT for Timers 6, 7 and 8:
-
-``` c
-//halconf.h:
-#define HAL_USE_DAC                 TRUE
-#define HAL_USE_GPT                 TRUE
-#include_next <halconf.h>
-```
-
-``` c
-// mcuconf.h:
-#include_next <mcuconf.h>
-#undef STM32_DAC_USE_DAC1_CH1
-#define STM32_DAC_USE_DAC1_CH1              TRUE
-#undef STM32_DAC_USE_DAC1_CH2
-#define STM32_DAC_USE_DAC1_CH2              TRUE
-#undef STM32_GPT_USE_TIM6
-#define STM32_GPT_USE_TIM6                  TRUE
-#undef STM32_GPT_USE_TIM7
-#define STM32_GPT_USE_TIM7                  TRUE
-#undef STM32_GPT_USE_TIM8
-#define STM32_GPT_USE_TIM8                  TRUE
-```
-
-?> Note: DAC1 (A4) uses TIM6, DAC2 (A5) uses TIM7, and the audio state timer uses TIM8 (configurable). 
-
-You can also change the timer used for the overall audio state by defining the driver.  For instance: 
-
-```c
-#define AUDIO_STATE_TIMER GPTD9
-```
-
-### DAC additive :id=dac-additive
-
-only needs one timer (GPTD6, Tim6) to trigger the DAC unit to do a conversion; the audio state updates are in turn triggered during the DAC callback.
-
-Additionally, in the board config, you'll want to make changes to enable the DACs, GPT for Timer 6:
-
-``` c
-//halconf.h:
-#define HAL_USE_DAC                 TRUE
-#define HAL_USE_GPT                 TRUE
-#include_next <halconf.h>
-```
-
-``` c
-// mcuconf.h:
-#include_next <mcuconf.h>
-#undef STM32_DAC_USE_DAC1_CH1
-#define STM32_DAC_USE_DAC1_CH1              TRUE
-#undef STM32_DAC_USE_DAC1_CH2
-#define STM32_DAC_USE_DAC1_CH2              TRUE
-#undef STM32_GPT_USE_TIM6
-#define STM32_GPT_USE_TIM6                  TRUE
-```
-
-### DAC Config
-
-| Define                           | Defaults                   | Description                                                --------------------------------------------------------------------------------------------- |
-| `AUDIO_DAC_SAMPLE_MAX`           | `4095U`                    | Highest value allowed. Lower value means lower volume. And 4095U is the upper limit, since this is limited to a 12 bit value. Only effects non-pregenerated samples.  |
-| `AUDIO_DAC_OFF_VALUE`            | `AUDIO_DAC_SAMPLE_MAX / 2` | The value of the DAC when notplaying anything. Some setups may require a high (`AUDIO_DAC_SAMPLE_MAX`) or low (`0`) value here.                                        |
-| `AUDIO_MAX_SIMULTANEOUS_TONES`   | __see next table__         | The number of tones that can be played simultaneously.  A value that is too high may freeze the controller or glitch out when too many tones are being played.        |
-| `AUDIO_DAC_SAMPLE_RATE`          | __see next table__         | Effective bit rate of the DAC (in hertz), higher limits simultaneous tones, and lower sacrifices quality.                                                          |
-
-There are a number of predefined quality settings that you can use, with "sane minimum" being the default.  You can use custom values by simply defining the sample rate and number of simultaneous tones, instead of using one of the listed presets. 
-
-| Define                            | Sample Rate | Simultaneous tones  |
-| `AUDIO_DAC_QUALITY_VERY_LOW`      | `11025U`    | `8`                 |
-| `AUDIO_DAC_QUALITY_LOW`           | `22040U`    | `4`                 |
-| `AUDIO_DAC_QUALITY_HIGH`          | `44100U`    | `2`                 |
-| `AUDIO_DAC_QUALITY_VERY_HIGH`     | `88200U`    | `1`                 |
-| `AUDIO_DAC_QUALITY_SANE_MINIMUM`  | `16384U`    | `8`                 |
-
-
-```c
-        /* zero crossing (or approach, whereas zero == DAC_OFF_VALUE, which can be configured to anything from 0 to DAC_SAMPLE_MAX)
-         * ============================*=*========================== AUDIO_DAC_SAMPLE_MAX
-         *                          *       *
-         *                        *           *
-         * ---------------------------------------------------------
-         *                     *                 *                  } AUDIO_DAC_SAMPLE_MAX/100
-         * --------------------------------------------------------- AUDIO_DAC_OFF_VALUE
-         *                  *                       *               } AUDIO_DAC_SAMPLE_MAX/100
-         * ---------------------------------------------------------
-         *               *
-         * *           *
-         *   *       *
-         * =====*=*================================================= 0x0
-         */
-```
-
-
-### PWM hardware :id=pwm-hardware
-
-This driver uses the ChibiOS-PWM system to produce a square-wave on specific output pins that are connected to the PWM hardware.
-The hardware directly toggles the pin via its alternate function. See your MCU's data-sheet for which pin can be driven by what timer - looking for TIMx_CHy and the corresponding alternate function.
-
-A configuration example for the STM32F103C8 would be:
-``` c
-//halconf.h:
-#define HAL_USE_PWM                 TRUE
-#define HAL_USE_PAL                 TRUE
-#define HAL_USE_GPT                 TRUE
-#include_next <halconf.h>
-```
-
-``` c
-// mcuconf.h:
-#include_next <mcuconf.h>
-#undef STM32_PWM_USE_TIM1
-#define STM32_PWM_USE_TIM1                  TRUE
-#undef STM32_GPT_USE_TIM4
-#define STM32_GPT_USE_TIM4                  TRUE
-```
-
-If we now target pin A8, looking through the data-sheet of the STM32F103C8, for the timers and alternate functions
-- TIM1_CH1 = PA8 <- alternate0
-- TIM1_CH2 = PA9
-- TIM1_CH3 = PA10
-- TIM1_CH4 = PA11
-
-with all this information, the configuration would contain these lines:
-``` c
-//config.h:
-#define AUDIO_PIN A8
-#define AUDIO_PWM_DRIVER PWMD1
-#define AUDIO_PWM_CHANNEL 1
-#define AUDIO_STATE_TIMER GPTD4
-```
-
-ChibiOS uses GPIOv1 for the F103, which only knows of one alternate function.
-On 'larger' STM32s, GPIOv2 or GPIOv3 are used; with them it is also necessary to configure `AUDIO_PWM_PAL_MODE` to the correct alternate function for the selected pin, timer and timer-channel.
-
-
-### PWM software :id=pwm-software
-
-This driver uses the PWM callbacks from PWMD1 with TIM1_CH1 to toggle the selected AUDIO_PIN in software.
-During the same callback, with AUDIO_PIN_ALT_AS_NEGATIVE set, the AUDIO_PIN_ALT is toggled inversely to AUDIO_PIN. This is useful for setups that drive a piezo from two pins (instead of one and Gnd).
-
-You can also change the timer used for software PWM by defining the driver.  For instance: 
-
-```c
-#define AUDIO_STATE_TIMER GPTD8
-```
-
-
-### Testing Notes :id=testing-notes
-
-While not an exhaustive list, the following table provides the scenarios that have been partially validated:
-
-|                          | DAC basic          | DAC additive       | PWM hardware       | PWM software       |
-|--------------------------|--------------------|--------------------|--------------------|--------------------|
-| Atmega32U4               | :o:                | :o:                | :heavy_check_mark: | :o:                |
-| STM32F103C8 (bluepill)   | :x:                | :x:                | :heavy_check_mark: | :heavy_check_mark: |
-| STM32F303CCT6 (proton-c) | :heavy_check_mark: | :heavy_check_mark: | ?                  | :heavy_check_mark: |
-| STM32F405VG              | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| L0xx                     | :x: (no Tim8)      | ?                  | ?                  | ?                  |
-
-
-:heavy_check_mark: : works and was tested  
-:o: : does not apply  
-:x: : not supported by MCU
-
-*Other supported ChibiOS boards and/or pins may function, it will be highly chip and configuration dependent.*

docs/breaking_changes.md

@@ -6,9 +6,6 @@ The breaking change period is when we will merge PR's that change QMK in dangero
 
 ## What has been included in past Breaking Changes?
 
-* [2021 Aug 28](ChangeLog/20210828.md)
-* [2021 May 29](ChangeLog/20210529.md)
-* [2021 Feb 27](ChangeLog/20210227.md)
 * [2020 Nov 28](ChangeLog/20201128.md)
 * [2020 Aug 29](ChangeLog/20200829.md)
 * [2020 May 30](ChangeLog/20200530.md)
@@ -17,16 +14,16 @@ The breaking change period is when we will merge PR's that change QMK in dangero
 
 ## When is the next Breaking Change?
 
-The next Breaking Change is scheduled for August 28, 2021.
+The next Breaking Change is scheduled for February 27, 2021.
 
 ### Important Dates
 
-* [x] 2021 Aug 29 - `develop` is created. Each push to `master` is subsequently merged to `develop`
-* [ ] 2021 Oct 31 - `develop` closed to new PR's.
-* [ ] 2021 Oct 31 - Call for testers.
-* [ ] 2021 Nov 26 - `master` is locked, no PR's merged.
-* [ ] 2021 Nov 28 - Merge `develop` to `master`.
-* [ ] 2021 Nov 28 - `master` is unlocked. PR's can be merged again.
+* [x] 2020 Nov 28 - `develop` is created. Each push to `master` is subsequently merged to `develop`
+* [ ] 2021 Jan 30 - `develop` closed to new PR's.
+* [ ] 2021 Jan 30 - Call for testers.
+* [ ] 2021 Feb 25 - `master` is locked, no PR's merged.
+* [ ] 2021 Feb 27 - Merge `develop` to `master`.
+* [ ] 2021 Feb 27 - `master` is unlocked. PR's can be merged again.
 
 ## What changes will be included?
 
@@ -57,7 +54,7 @@ This happens immediately after the previous `develop` branch is merged.
     * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'`
     * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>`
     * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing
-    * [ ] `git push upstream develop`
+    * [ ] `git push origin develop`
     * [ ] `git push --tags`
 
 ## 4 Weeks Before Merge
@@ -87,20 +84,13 @@ This happens immediately after the previous `develop` branch is merged.
 * `qmk_firmware` git commands
     * [ ] `git checkout develop`
     * [ ] `git pull --ff-only`
+    * [ ] `git rebase origin/master`
     * [ ] Edit `readme.md`
         * [ ] Remove the notes about `develop`
     * [ ] Roll up the ChangeLog into one file.
     * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'`
-    * [ ] `git push upstream develop`
+    * [ ] `git push origin develop`
 * GitHub Actions
     * [ ] Create a PR for `develop`
-    * [ ] **Turn off 'Automatically delete head branches' for the repository** -- confirm with @qmk/directors that it is done before continuing
-* `qmk_firmware` git commands
-    * [ ] `git checkout master`
-    * [ ] `git pull --ff-only`
-    * [ ] `git merge --no-ff develop`
-    * [ ] `git push upstream master`
-
-## Post-merge operations
-
-* (Optional) [update ChibiOS + ChibiOS-Contrib on `develop`](chibios_upgrade_instructions.md)
+    * [ ] Make sure travis comes back clean
+    * [ ] Merge `develop` PR

docs/breaking_changes_history.md

@@ -1,12 +0,0 @@
-# Past Breaking Changes
-
-This page links to all previous changelogs from the QMK Breaking Changes process.
-
-* [2021 Aug 28](ChangeLog/20210828.md) - version 0.14.0
-* [2021 May 29](ChangeLog/20210529.md) - version 0.13.0
-* [2021 Feb 27](ChangeLog/20210227.md) - version 0.12.0
-* [2020 Nov 28](ChangeLog/20201128.md) - version 0.11.0
-* [2020 Aug 29](ChangeLog/20200829.md) - version 0.10.0
-* [2020 May 30](ChangeLog/20200530.md) - version 0.9.0
-* [2020 Feb 29](ChangeLog/20200229.md) - version 0.8.0
-* [2019 Aug 30](ChangeLog/20190830.md) - version 0.7.0

docs/chibios_upgrade_instructions.md

@@ -1,56 +0,0 @@
-# ChibiOS Upgrade Procedure
-
-ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a branch tied to the ChibiOS version in use and should not be mixed with different versions.
-
-## Getting ChibiOS
-
-* `svn` Initialisation:
-    * Only needed to be done once
-    * You might need to separately install `git-svn` package in your OS's package manager
-    * `git svn init --stdlayout --prefix='svn/' http://svn.osdn.net/svnroot/chibios/`
-    * `git remote add qmk git@github.com:qmk/ChibiOS.git`
-* Updating:
-    * `git svn fetch`
-    * First time around this will take several hours
-    * Subsequent updates will be incremental only
-* Tagging example (work out which version first!):
-    * `git tag -a ver20.3.3 -m ver20.3.3 svn/tags/ver20.3.3`
-    * `git push qmk ver20.3.3`
-    * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN svn/tags/ver20.3.3`
-    * `git push qmk breaking_YYYY_qN`
-
-## Getting ChibiOS-Contrib
-
-* `git` Initialisation:
-    * `git clone git@github.com:qmk/ChibiOS-Contrib`
-    * `git remote add upstream https://github.com/ChibiOS/ChibiOS-Contrib`
-    * `git checkout -b chibios-20.3.x upstream/chibios-20.3.x`
-* Updating:
-    * `git fetch --all --tags --prune`
-    * `git checkout chibios-20.3.x`
-    * `git pull --ff-only`
-    * `git push origin chibios-20.3.x`
-    * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN chibios-20.3.x`
-    * `git push origin breaking_YYYY_qN`
-
-## Updating submodules
-
-* Update the submodules
-    * `cd $QMK_FIRMWARE`
-    * `git checkout develop`
-    * `git pull --ff-only`
-    * `git checkout -b chibios-version-bump`
-    * `cd lib/chibios`
-    * `git fetch --all --tags --prune`
-    * `git checkout breaking_YYYY_qN`
-    * `cd ../chibios-contrib`
-    * `git fetch --all --tags --prune`
-    * `git checkout breaking_YYYY_qN`
-* Build everything
-    * `cd $QMK_FIRMWARE`
-    * `qmk multibuild -j4`
-    * Make sure there are no errors
-* Push to the repo
-    * `git commit -am 'Update ChibiOS to XXXXXXXXX'`
-    * `git push --set-upstream origin chibios-version-bump`
-* Make a PR to qmk_firmware with the new branch

docs/cli_commands.md

@@ -17,7 +17,7 @@ qmk compile [-c] <configuratorExport.json>
 **Usage for Keymaps**:
 
 ```
-qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name>
+qmk compile [-c] [-e <var>=<value>] -kb <keyboard_name> -km <keymap_name>
 ```
 
 **Usage in Keyboard Directory**:  
@@ -73,17 +73,6 @@ $ qmk compile -kb dz60
 ...
 ```
 
-**Parallel Compilation**:
-
-It is possible to speed up compilation by adding the `-j`/`--parallel` flag.
-```
-qmk compile -j <num_jobs> -kb <keyboard_name>
-```
-The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs.
-```
-qmk compile -j 0 -kb <keyboard_name>
-```
-
 ## `qmk flash`
 
 This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. To specify a different bootloader, use `-bl <bootloader>`. Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders.
@@ -93,13 +82,13 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K
 **Usage for Configurator Exports**:
 
 ```
-qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configuratorExport.json>
+qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] <configuratorExport.json>
 ```
 
 **Usage for Keymaps**:
 
 ```
-qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]
+qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>]
 ```
 
 **Listing the Bootloaders**
@@ -118,54 +107,6 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d
 qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
 ```
 
-## `qmk console`
-
-This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLE=yes`.
-
-**Usage**:
-
-```
-qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>]
-```
-
-**Examples**:
-
-Connect to all available keyboards and show their console messages:
-
-```
-qmk console
-```
-
-List all devices:
-
-```
-qmk console -l
-```
-
-Show only messages from clueboard/66/rev3 keyboards:
-
-```
-qmk console -d C1ED:2370
-```
-
-Show only messages from the second clueboard/66/rev3:
-
-```
-qmk console -d C1ED:2370:2
-```
-
-Show timestamps and VID:PID instead of names:
-
-```
-qmk console -n -t
-```
-
-Disable bootloader messages:
-
-```
-qmk console --no-bootloaders
-```
-
 ## `qmk doctor`
 
 This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to.
@@ -190,16 +131,6 @@ Check your environment and report problems only:
 
     qmk doctor -n
 
-## `qmk format-json`
-
-Formats a JSON file in a (mostly) human-friendly way. Will usually correctly detect the format of the JSON (info.json or keymap.json) but you can override this with `--format` if neccesary.
-
-**Usage**:
-
-```
-qmk format-json [-f FORMAT] <json_file>
-```
-
 ## `qmk info`
 
 Displays information about keyboards and keymaps in QMK. You can use this to get information about a keyboard, show the layouts, display the underlying key matrix, or to pretty-print JSON keymaps.
@@ -239,7 +170,7 @@ qmk json2c [-o OUTPUT] filename
 ## `qmk c2json`
 
 Creates a keymap.json from a keymap.c.  
-**Note:** Parsing C source files is not easy, therefore this subcommand may not work with your keymap. In some cases not using the C pre-processor helps.
+**Note:** Parsing C source files is not easy, therefore this subcommand may not work your keymap. In some cases not using the C pre-processor helps.
 
 **Usage**:
 
@@ -287,18 +218,6 @@ This command is directory aware. It will automatically fill in KEYBOARD if you a
 qmk list-keymaps -kb planck/ez
 ```
 
-## `qmk new-keyboard`
-
-This command creates a new keyboard based on available templates.
-
-Any arguments that are not provided will prompt for input. If `-u` is not passed and `user.name` is set in .gitconfig, it will be used as the default username in the prompt.
-
-**Usage**:
-
-```
-qmk new-keyboard [-kb KEYBOARD] [-t {avr,ps2avrgb}] -u USERNAME
-```
-
 ## `qmk new-keymap`
 
 This command creates a new keymap based on a keyboard's existing default keymap.
@@ -325,18 +244,7 @@ qmk clean [-a]
 
 # Developer Commands
 
-## `qmk format-text`
-
-This command formats text files to have proper line endings. 
-
-Every text file in the repository needs to have Unix (LF) line ending.
-If you are working on **Windows**, you must ensure that line endings are corrected in order to get your PRs merged.
-
-```
-qmk format-text
-```
-
-## `qmk format-c`
+## `qmk cformat`
 
 This command formats C code using clang-format. 
 
@@ -347,36 +255,35 @@ Run it with `-a` to format all core code, or pass filenames on the command line
 **Usage for specified files**:
 
 ```
-qmk format-c [file1] [file2] [...] [fileN]
+qmk cformat [file1] [file2] [...] [fileN]
 ```
 
 **Usage for all core files**:
 
 ```
-qmk format-c -a
+qmk cformat -a
 ```
 
 **Usage for only changed files against origin/master**:
 
 ```
-qmk format-c
+qmk cformat
 ```
 
 **Usage for only changed files against branch_name**:
 
 ```
-qmk format-c -b branch_name
+qmk cformat -b branch_name
 ```
 
 ## `qmk docs`
 
 This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
-Use the `-b`/`--browser` flag to automatically open the local webserver in your default browser.
 
 **Usage**:
 
 ```
-qmk docs [-b] [-p PORT]
+qmk docs [-p PORT]
 ```
 
 ## `qmk generate-docs`
@@ -391,7 +298,7 @@ qmk generate-docs
 
 ## `qmk generate-rgb-breathe-table`
 
-This command generates a lookup table (LUT) header file for the [RGB Lighting](feature_rgblight.md) feature's breathing animation. Place this file in your keyboard or keymap directory as `rgblight_breathe_table.h` to override the default LUT in `quantum/rgblight/`.
+This command generates a lookup table (LUT) header file for the [RGB Lighting](feature_rgblight.md) feature's breathing animation. Place this file in your keyboard or keymap directory as `rgblight_breathe_table.h` to override the default LUT in `quantum/`.
 
 **Usage**:
 
@@ -421,14 +328,14 @@ $ qmk kle2json -f kle.txt -f
 Ψ Wrote out to info.json
 ```
 
-## `qmk format-python`
+## `qmk pyformat`
 
 This command formats python code in `qmk_firmware`.
 
 **Usage**:
 
 ```
-qmk format-python
+qmk pyformat
 ```
 
 ## `qmk pytest`

docs/cli_development.md

@@ -188,7 +188,7 @@ cli.log.info('Reading from %s and writing to %s', cli.args.filename, cli.args.ou
 
 # Testing, and Linting, and Formatting (oh my!)
 
-We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `format-py` subcommands to run these tests:
+We use nose2, flake8, and yapf to test, lint, and format code. You can use the `pytest` and `pyformat` subcommands to run these tests:
 
 ### Testing and Linting
 
@@ -196,7 +196,7 @@ We use nose2, flake8, and yapf to test, lint, and format code. You can use the `
 
 ### Formatting
 
-    qmk format-py
+    qmk pyformat
 
 ## Formatting Details
 

docs/cli_tab_complete.md

@@ -1,27 +0,0 @@
-# Tab Completion for QMK
-
-If you are using Bash 4.2 or later, Zsh, or FiSH you can enable Tab Completion for the QMK CLI. This will let you tab complete the names of flags, keyboards, files, and other `qmk` options.
-
-## Setup
-
-There are several ways you can setup tab completion.
-
-### For Your User Only
-
-Add this to the end of your `.profile` or `.bashrc`:
-
-    source ~/qmk_firmware/util/qmk_tab_complete.sh
-
-If you put `qmk_firmware` into another location you will need to adjust this path.
-
-### System Wide Symlink
-
-If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:
-
-    `ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh`
-
-### System Wide Copy
-
-In some cases a symlink may not work. Instead you can copy the file directly into place. Be aware that updates to the tab complete script may happen from time to time, you will want to recopy the file periodically.
-
-    cp util/qmk_tab_complete.sh /etc/profile.d

docs/compatible_microcontrollers.md

@@ -9,7 +9,6 @@ The following use [LUFA](https://www.fourwalledcubicle.com/LUFA.php) as the USB
 * [ATmega16U2](https://www.microchip.com/wwwproducts/en/ATmega16U2) / [ATmega32U2](https://www.microchip.com/wwwproducts/en/ATmega32U2)
 * [ATmega16U4](https://www.microchip.com/wwwproducts/en/ATmega16U4) / [ATmega32U4](https://www.microchip.com/wwwproducts/en/ATmega32U4)
 * [AT90USB64](https://www.microchip.com/wwwproducts/en/AT90USB646) / [AT90USB128](https://www.microchip.com/wwwproducts/en/AT90USB1286)
-* [AT90USB162](https://www.microchip.com/wwwproducts/en/AT90USB162)
 
 Certain MCUs which do not have native USB will use [V-USB](https://www.obdev.at/products/vusb/index.html) instead:
 
@@ -26,16 +25,6 @@ You can also use any ARM chip with USB that [ChibiOS](https://www.chibios.org) s
  * [STM32F0x2](https://www.st.com/en/microcontrollers-microprocessors/stm32f0x2.html)
  * [STM32F103](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html)
  * [STM32F303](https://www.st.com/en/microcontrollers-microprocessors/stm32f303.html)
- * [STM32F401](https://www.st.com/en/microcontrollers-microprocessors/stm32f401.html)
- * [STM32F407](https://www.st.com/en/microcontrollers-microprocessors/stm32f407-417.html)
- * [STM32F411](https://www.st.com/en/microcontrollers-microprocessors/stm32f411.html)
- * [STM32F446](https://www.st.com/en/microcontrollers-microprocessors/stm32f446.html)
- * [STM32G431](https://www.st.com/en/microcontrollers-microprocessors/stm32g4x1.html)
- * [STM32G474](https://www.st.com/en/microcontrollers-microprocessors/stm32g4x4.html)
- * [STM32L412](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x2.html)
- * [STM32L422](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x2.html)
- * [STM32L433](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x3.html)
- * [STM32L443](https://www.st.com/en/microcontrollers-microprocessors/stm32l4x3.html)
 
 ### NXP (Kinetis)
 

docs/config_options.md

@@ -51,10 +51,8 @@ This is a C header file that is one of the first things included, and will persi
   * the number of columns in your keyboard's matrix
 * `#define MATRIX_ROW_PINS { D0, D5, B5, B6 }`
   * pins of the rows, from top to bottom
-  * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information.
 * `#define MATRIX_COL_PINS { F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7 }`
   * pins of the columns, from left to right
-  * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information.
 * `#define MATRIX_IO_DELAY 30`
   * the delay in microseconds when between changing matrix pin state and reading values
 * `#define UNUSED_PINS { D1, D2, D3, B1, B2, B3 }`
@@ -69,22 +67,16 @@ This is a C header file that is one of the first things included, and will persi
   * turns on the alternate audio voices (to cycle through)
 * `#define C4_AUDIO`
   * enables audio on pin C4
-  * Deprecated. Use `#define AUDIO_PIN C4`
 * `#define C5_AUDIO`
   * enables audio on pin C5
-  * Deprecated. Use `#define AUDIO_PIN C5`
 * `#define C6_AUDIO`
   * enables audio on pin C6
-  * Deprecated. Use `#define AUDIO_PIN C6`
 * `#define B5_AUDIO`
-  * enables audio on pin B5 (duophony is enabled if one of B pins is enabled along with one of C pins)
-  * Deprecated. Use `#define AUDIO_PIN B5`, or use `#define AUDIO_PIN_ALT B5` if a `C` pin is enabled with `AUDIO_PIN`
+  * enables audio on pin B5 (duophony is enables if one of B[5-7]\_AUDIO is enabled along with one of C[4-6]\_AUDIO)
 * `#define B6_AUDIO`
-  * enables audio on pin B6 (duophony is enabled if one of B pins is enabled along with one of C pins)
-  * Deprecated. Use `#define AUDIO_PIN B6`, or use `#define AUDIO_PIN_ALT B6` if a `C` pin is enabled with `AUDIO_PIN`
+  * enables audio on pin B6 (duophony is enables if one of B[5-7]\_AUDIO is enabled along with one of C[4-6]\_AUDIO)
 * `#define B7_AUDIO`
-  * enables audio on pin B7 (duophony is enabled if one of B pins is enabled along with one of C pins)
-  * Deprecated. Use `#define AUDIO_PIN B7`, or use `#define AUDIO_PIN_ALT B7` if a `C` pin is enabled with `AUDIO_PIN`
+  * enables audio on pin B7 (duophony is enables if one of B[5-7]\_AUDIO is enabled along with one of C[4-6]\_AUDIO)
 * `#define BACKLIGHT_PIN B7`
   * pin of the backlight
 * `#define BACKLIGHT_LEVELS 3`
@@ -105,8 +97,6 @@ This is a C header file that is one of the first things included, and will persi
   * sets the maximum power (in mA) over USB for the device (default: 500)
 * `#define USB_POLLING_INTERVAL_MS 10`
   * sets the USB polling rate in milliseconds for the keyboard, mouse, and shared (NKRO/media keys) interfaces
-* `#define USB_SUSPEND_WAKEUP_DELAY 200`
-  * set the number of milliseconde to pause after sending a wakeup packet
 * `#define F_SCL 100000L`
   * sets the I2C clock rate speed for keyboards using I2C. The default is `400000L`, except for keyboards using `split_common`, where the default is `100000L`.
 
@@ -188,27 +178,13 @@ If you define these options you will enable the associated feature, which may in
     few ms of delay from this. But if you're doing chording on something with 3-4ms
     scan times? You probably want this.
 * `#define COMBO_COUNT 2`
-  * Set this to the number of combos that you're using in the [Combo](feature_combo.md) feature. Or leave it undefined and programmatically set the count.
+  * Set this to the number of combos that you're using in the [Combo](feature_combo.md) feature.
 * `#define COMBO_TERM 200`
   * how long for the Combo keys to be detected. Defaults to `TAPPING_TERM` if not defined.
-* `#define COMBO_MUST_HOLD_MODS`
-  * Flag for enabling extending timeout on Combos containing modifers
-* `#define COMBO_MOD_TERM 200`
-  * Allows for extending COMBO_TERM for mod keys while mid-combo. 
-* `#define COMBO_MUST_HOLD_PER_COMBO`
-  * Flag to enable per-combo COMBO_TERM extension and `get_combo_must_hold()` function
-* `#define COMBO_TERM_PER_COMBO`
-  * Flag to enable per-combo COMBO_TERM extension and `get_combo_term()` function
-* `#define COMBO_STRICT_TIMER`
-  * Only start the combo timer on the first key press instead of on all key presses.
-* `#define COMBO_NO_TIMER`
-  * Disable the combo timer completely for relaxed combos.
 * `#define TAP_CODE_DELAY 100`
   * Sets the delay between `register_code` and `unregister_code`, if you're having issues with it registering properly (common on VUSB boards). The value is in milliseconds.
 * `#define TAP_HOLD_CAPS_DELAY 80`
   * Sets the delay for Tap Hold keys (`LT`, `MT`) when using `KC_CAPSLOCK` keycode, as this has some special handling on MacOS.  The value is in milliseconds, and defaults to 80 ms if not defined. For macOS, you may want to set this to 200 or higher.
-* `#define KEY_OVERRIDE_REPEAT_DELAY 500`
-  * Sets the key repeat interval for [key overrides](feature_key_overrides.md).
 
 ## RGB Light Configuration
 
@@ -288,7 +264,7 @@ There are a few different ways to set handedness for split keyboards (listed in
 ### Other Options
 
 * `#define USE_I2C`
-  * For using I2C instead of Serial (default is serial; serial transport is supported on ARM -- I2C is AVR-only)
+  * For using I2C instead of Serial (defaults to serial)
 
 * `#define SOFT_SERIAL_PIN D0`
   * When using serial, define this. `D0` or `D1`,`D2`,`D3`,`E6`.
@@ -296,7 +272,6 @@ There are a few different ways to set handedness for split keyboards (listed in
 * `#define MATRIX_ROW_PINS_RIGHT { <row pins> }`
 * `#define MATRIX_COL_PINS_RIGHT { <col pins> }`
   * If you want to specify a different pinout for the right half than the left half, you can define `MATRIX_ROW_PINS_RIGHT`/`MATRIX_COL_PINS_RIGHT`. Currently, the size of `MATRIX_ROW_PINS` must be the same as `MATRIX_ROW_PINS_RIGHT` and likewise for the definition of columns.
-  * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information.
 
 * `#define DIRECT_PINS_RIGHT { { F1, F0, B0, C7 }, { F4, F5, F6, F7 } }`
   * If you want to specify a different direct pinout for the right half than the left half, you can define `DIRECT_PINS_RIGHT`. Currently, the size of `DIRECT_PINS` must be the same as `DIRECT_PINS_RIGHT`.
@@ -317,7 +292,7 @@ There are a few different ways to set handedness for split keyboards (listed in
 * `#define SPLIT_USB_DETECT`
   * Detect (with timeout) USB connection when delegating master/slave
   * Default behavior for ARM
-  * Required for AVR Teensy (without hardware mods)
+  * Required for AVR Teensy
 
 * `#define SPLIT_USB_TIMEOUT 2000`
   * Maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT`
@@ -325,34 +300,6 @@ There are a few different ways to set handedness for split keyboards (listed in
 * `#define SPLIT_USB_TIMEOUT_POLL 10`
   * Poll frequency when detecting master/slave when using `SPLIT_USB_DETECT`
 
-* `#define FORCED_SYNC_THROTTLE_MS 100`
-  * Deadline for synchronizing data from master to slave when using the QMK-provided split transport.
-
-* `#define SPLIT_TRANSPORT_MIRROR`
-  * Mirrors the master-side matrix on the slave when using the QMK-provided split transport.
-
-* `#define SPLIT_LAYER_STATE_ENABLE`
-  * Ensures the current layer state is available on the slave when using the QMK-provided split transport.
-
-* `#define SPLIT_LED_STATE_ENABLE`
-  * Ensures the current host indicator state (caps/num/scroll) is available on the slave when using the QMK-provided split transport.
-
-* `#define SPLIT_MODS_ENABLE`
-  * Ensures the current modifier state (normal, weak, and oneshot) is available on the slave when using the QMK-provided split transport.
-
-* `#define SPLIT_WPM_ENABLE`
-  * Ensures the current WPM is available on the slave when using the QMK-provided split transport.
-
-* `#define SPLIT_OLED_ENABLE`
-  * Syncs the on/off state of the OLED between the halves.
-
-* `#define SPLIT_ST7565_ENABLE`
-  * Syncs the on/off state of the ST7565 screen between the halves.
-
-* `#define SPLIT_TRANSACTION_IDS_KB .....`
-* `#define SPLIT_TRANSACTION_IDS_USER .....`
-  * Allows for custom data sync with the slave when using the QMK-provided split transport. See [custom data sync between sides](feature_split_keyboard.md#custom-data-sync) for more information.
-
 # The `rules.mk` File
 
 This is a [make](https://www.gnu.org/software/make/manual/make.html) file that is included by the top-level `Makefile`. It is used to set some information about the MCU that we will be compiling for as well as enabling and disabling certain features.
@@ -420,8 +367,6 @@ Use these to enable or disable building certain features. The more you have enab
   * USB N-Key Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 * `AUDIO_ENABLE`
   * Enable the audio subsystem.
-* `KEY_OVERRIDE_ENABLE`
-  * Enable the key override feature
 * `RGBLIGHT_ENABLE`
   * Enable keyboard underlight functionality
 * `LEADER_ENABLE`

docs/configurator_architecture.md

@@ -1,61 +0,0 @@
-# QMK Configurator Architecture
-
-This page describes the web architecture behind QMK Configurator at a high level. If you are interested in the architecture of the QMK Configurator code itself you should start at the [qmk_configurator](https://github.com/qmk/qmk_configurator) repository.
-
-# Overview
-
-![QMK Configurator Architecture Diagram](configurator_diagram.svg)
-
-# Detailed Description
-
-QMK Configurator is a [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application) that allows users to create custom keymaps for their QMK-compatible keyboard. They can export JSON representation of their keymaps and compile firmware binaries that can be flashed to their keyboard using a tool like [QMK Toolbox](https://github.com/qmk/qmk_toolbox).
-
-Configurator gets metadata about keyboards from the Keyboard Metadata store and submits compile requests to the QMK API. The results of those compile requests will be made available on [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces/), an S3-compatible data store.
-
-## Configurator Frontend
-
-Address: <https://config.qmk.fm>
-
-The [Configurator Frontend](https://config.qmk.fm) is compiled into a set of static files that are served by Github Pages. This action happens every time a commit is pushed to the [qmk_configurator `master`](https://github.com/qmk/qmk_configurator) branch. You can view the status of these jobs on the [qmk_configurator actions tab](https://github.com/qmk/qmk_configurator/actions/workflows/build.yml).
-
-## Keyboard Metadata
-
-Address: <https://keyboards.qmk.fm>
-
-The Keyboard Metadata is generated every time a keyboard in [qmk_firmware](https://github.com/qmk/qmk_firmware) changes. The resulting JSON files are uploaded to Spaces and used by Configurator to generate UI for each keyboard. You can view the status of this job on the [qmk_firmware actions tab](https://github.com/qmk/qmk_firmware/actions/workflows/api.yml). If you are a QMK Collaborator you can manually run this job using the `workflow_dispatch` event trigger.
-
-## QMK API
-
-Address: <http://api.qmk.fm>
-
-The QMK API accepts `keymap.json` files for compilation. These are the same files you can use directly with `qmk compile` and `qmk flash`. When a `keymap.json` is submitted the browser will poll the status of the job periodically (every 2 seconds or longer, preferably) until the job has completed. The final status JSON will contain pointers to source and binary downloads for the keymap.
-
-QMK API always presents the source and binary downloads side-by-side to comply with the GPL.
-
-There are 3 non-error status responses from the API-
-
-1. Compile Job Queued
-2. Compile Job Running
-3. Compile Job Finished
-
-### Compile Job Queued
-
-This status indicates that the job has not yet been picked up by a [QMK Compiler](#qmk-compiler) node. Configurator shows this status as "Waiting for an oven".
-
-### Compile Job Running
-
-This status indicates that the job has started compiling. Configurator shows this status as "Baking".
-
-### Compile Job Finished
-
-This status indicates that the job has completed. There will be keys in the status JSON for source and binary downloads.
-
-## Redis/RQ
-
-QMK API uses RQ to distribute jobs to the available [QMK Compiler](#qmk-compiler) nodes. When a `keymap.json` is received it's put into the RQ queue, where a `qmk_compiler` node will pick it up from.
-
-## QMK Compiler
-
-[QMK Compiler](https://github.com/qmk/qmk_compiler) is what actually performs the compilation of the `keymap.json`. It does so by checking out the requested `qmk_firmware` branch, running `qmk compile keymap.json`, and then uploading the resulting source and binary to Digital Ocean Spaces. 
-
-When users download their source/binary, API will redirect them to the authenticated Spaces download URL.

docs/configurator_diagram.drawio

@@ -1 +0,0 @@
-<mxfile host="Electron" modified="2021-08-09T19:46:29.036Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="PQ2r34UrZa0TfW4Fw0EV" version="14.6.13" type="device"><diagram id="NEtccoSKIy4HskWlhJpu" name="Page-1">5VvbcqM4EP2a1O4+hOLqy2Ni5zKX1CTxzszOU0oG2dZEIBZEYu/XbwuEDQg7csZ2vFlXjQca0RLdR+eohXPiDML5VYLi2Q0LMD2xzWB+4gxPbNvqezb8JywLaTFtr7BMExJI28owIv/gsqG0ZiTAaa0hZ4xyEteNPosi7POaDSUJe643mzBa7zVGU6wYRj6iqvU7CfissPY8c2W/xmQ6K3u2THklRGVjaUhnKGDPFZNzceIMEsZ4cRTOB5iK6JVxKe67XHN1ObAER1znhgfT76Zzxxp3Z49j5+7zjw/z+NSS+XlCNJNPLEfLF2UIcAARkacs4TM2ZRGiFyvrecKyKMCiHxPOVm0+MxaD0QLjT8z5QqYXZZyBacZDKq/iKDgTyYLTiEW4sFwSSqXLAKWz3L9orD64jEXKssTHG57WlQBCyRTzTVGRDsWTV3qQcb3CLMQ8WUCDBFPEyVMdK0hCbrpst8oKHMjEbJEk9+UckTDHcTWm0jQk4RR6pWQM3z4l8QNKuDhkYZxxnKRw/J0ljymHJ2HRg2X35vDPiKPp2kA/4YTj+cbIyKunjmv0zMpHeljSQXH6XJla0jSrzKrStvPIei9Hdgm9HNoZpyTCgyXZmPWYI0qmERz7EDGcgIGiMaa3LCUittULIoQEaOZzo8GYcc7CSoMz6ZKLqXQOJBKLgYXzqSBc4xmPKcy11JgSPsvG0GLCIn6JQkJFiK8xfcLCjbwgJyDM+uJ8wChL8ud0ivSILnjCHnHblQlMyIp9kn/ADkMJCK55G14OL4YXmybrFhhyOzXQtKEGdMVwVeBUzDvHTjmKjdS54jWfojQlfpP3YCR/CRwZXnn6o3ptOJcgK84W8gwma8JVz7lZ0qZVI9Ff401PkzddTdqsJM5rme6lTZtdZQ+3jMCTLXFjlRkqyaZJI8Vzy7uqytl01Gk4chqOisAojnJYLR/7F5BWTpkV0gZUTDjgbnOUxTEorqCosxO7QyGG5+MEjqbiaDBLoPsTGzo2L0mCJ2yuNhri9FHQi21+iehCAfHzjHA8ilEOkWegnTqGm0QVkiDIVwU5950j/3Garw9Kdsjd7YYZlmurkhlUYrDNFoB19qUnltPCCUW40xhFZcBnnIvl65noTChxNCFT4+/w0ZiEZXOwV+9Qk9bmd0SiKYTeNm+F9AM2RKTX3tno4iN6QiM/IbFYHXz7eqHeOJI8AeM2YbTQDL4fiuFnCeIs0RvmNUt54eWqUK1iwOnaZ28Asr7cfC0894E/q2PYehDs7w2CGqtFdbndqklVRaoI1BpN2tEaXVdryql2JGKzTKiEgvdasXHchqNDi01XAz/vpiK0tOHW0YTbYUpC6/1ULj9TuH0XlWZ93riOuhjotsz/rmf09pWkjpKkuvI/4sWYoSRIG+K/ks9PsgV4ucEcBYgjXV2ekCR8hoiq7a+uoeGZX+RN3PQ1BsdiwXB2+wG+h629rFR7SKDaRPSLj4VIm7n2ptsuG2voPKRIu7Zt9N9apHtbiXRr7VirASVHVgtAc4cFoDZNekclypZnWK5p9Tp9y+v1up1y73nRQMbWBWHdz3LP90ASbav14HuW6L4m9spsHotE95Us3d18Kkm2mS5KSZziik76lGXBy+XNLpTTq8O5Y6rKadkts3Rv27JlZ2uFE8VkrWTeX4z+nGS0DLSeWILDTYp3jyJ/Bqsf2xRrFXP4Bb6+3fy2tegdUuc6pqenct29pVFjkfryDulhtzDLWXskCnbarCtd75WadaoUlpqqBelBi0qzWDRINwzZanTkOObmkTVv8Pq1G+CgGMNuRVSl53csonZXV0R7RyWitrobIasPMMoCRGF4WY807b+PnD+OS3idXh347fuHrdrbt8qWu4+5WpzU1RcE81QocLTwHcMPIiMoUsJEPtI8+obPWqRZRlNK7+kLoqskejut3UWCeg1msh3L6PYrn54qsf2WbO3thYOjrpTeTGK1Oea4ikSQ/EaSX7t1qwiZfeC9W6ft9dO71TSn/D3YS3hz7KPSNEct3+/vlDyVciS2/FLOEnwYSWpskXS7ai3YOSjB2WqwcEDEm+9cjEwRuqaGfGTineJdhrOW3c/2AjApnO6/BNxBkpqVXrfz1pWes91Lx73KkPZ+UTkP31qHyiw26zFt2fEacGiWiPtWHXWNXvwuIIwpETNmDbPhuZhhAcvG+RWrJj3Wm2x99Vt+QXLYrS9XXdAVu4YDCCehIpztbHefRVH+a07dX22sc/efoLy+/daU5+pswh+I8vRXQt3joDyZVbeW015ztaxLgHU3/eZbnT3Tn6uuULYGwoF/z+lo7wYdF16AHes00GuuO/V3Qxui2bP0ULP1bqjTYK5yS2Gvm5vu/6sQ1IVzKa67KwTXEJK3GVu6KLWd14H0ZRjB6eovj4rmqz/gci7+BQ==</diagram></mxfile>

docs/contributing.md

@@ -148,7 +148,7 @@ Feature and Bug Fix PR's affect all keyboards. We are also in the process of res
 Here are some things to keep in mind when working on your feature or bug fix.
 
 * **Disabled by default** - memory is a pretty limited on most chips QMK supports, and it's important that current keymaps aren't broken, so please allow your feature to be turned **on**, rather than being turned off. If you think it should be on by default, or reduces the size of the code, please talk with us about it.
-* **Compile locally before submitting** - hopefully this one is obvious, but things need to compile! You should always make sure your changes compile before opening a pull request.
+* **Compile locally before submitting** - hopefully this one is obvious, but things need to compile! Our Travis system will catch any issues, but it's generally faster for you to compile a few keyboards locally instead of waiting for the results to come back.
 * **Consider revisions and different chip-bases** - there are several keyboards that have revisions that allow for slightly different configurations, and even different chip-bases. Try to make a feature supported in ARM and AVR, or automatically disabled on platforms it doesn't work on.
 * **Explain your feature** - Document it in `docs/`, either as a new file or as part of an existing file. If you don't document it other people won't be able to benefit from your hard work.
 

docs/custom_quantum_functions.md

@@ -144,14 +144,6 @@ This is useful for setting up stuff that you may need elsewhere, but isn't hardw
 * Keyboard/Revision: `void matrix_init_kb(void)`
 * Keymap: `void matrix_init_user(void)`
 
-### Low-level Matrix Overrides Function Documentation :id=low-level-matrix-overrides
-
-* GPIO pin initialisation: `void matrix_init_pins(void)`
-  * This needs to perform the low-level initialisation of all row and column pins. By default this will initialise the input/output state of each of the GPIO pins listed in `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no initialisation of pin state will occur within QMK itself, instead deferring to the keyboard's override.
-* `COL2ROW`-based row reads: `void matrix_read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)`
-* `ROW2COL`-based column reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)`
-* `DIRECT_PINS`-based reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)`
-  * These three functions need to perform the low-level retrieval of matrix state of relevant input pins, based on the matrix type. Only one of the functions should be implemented, if needed. By default this will iterate through `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, configuring the inputs and outputs based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no manipulation of matrix GPIO pin state will occur within QMK itself, instead deferring to the keyboard's override.
 
 ## Keyboard Post Initialization code
 
@@ -382,7 +374,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
   }
 }
 ```
-And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EEP_RST` keycode or [Bootmagic Lite](feature_bootmagic.md) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued.
+And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EEP_RST` keycode or [Bootmagic](feature_bootmagic.md) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued. 
 
 ```c
 void eeconfig_init_user(void) {  // EEPROM is getting reset!

docs/data_driven_config.md

@@ -1,91 +0,0 @@
-# Data Driven Configuration
-
-This page describes how QMK's data driven JSON configuration system works. It is aimed at developers who want to work on QMK itself.
-
-## History
-
-Historically QMK has been configured through a combination of two mechanisms- `rules.mk` and `config.h`. While this worked well when QMK was only a handful of keyboards we've grown to encompass nearly 1500 supported keyboards. That extrapolates out to 6000 configuration files under `keyboards/` alone! The freeform nature of these files and the unique patterns people have used to avoid duplication have made ongoing maintenance a challenge, and a large number of our keyboards follow patterns that are outdated and sometimes harder to understand.
-
-We have also been working on bringing the power of QMK to people who aren't comformable with a CLI, and other projects such as VIA are working to make using QMK as easy as installing a program. These tools need information about how a keyboard is laid out or what pins and features are available so that users can take full advantage of QMK. We introduced `info.json` as a first step towards this. The QMK API is an effort to combine these 3 sources of information- `config.h`, `rules.mk`, and `info.json`- into a single source of truth that end-user tools can use.
-
-Now we have support for generating `rules.mk` and `config.h` values from `info.json`, allowing us to have a single source of truth. This will allow us to use automated tooling to maintain keyboards saving a lot of time and maintenance work.
-
-## Overview
-
-On the C side of things nothing changes. When you need to create a new rule or define you follow the same process:
-
-1. Add it to `docs/config_options.md`
-1. Set a default in the appropriate core file
-1. Add your ifdef statements as needed
-
-You will then need to add support for your new configuration to `info.json`. The basic process is:
-
-1. Add it to the schema in `data/schemas/keyboards.jsonschema`
-1. Add a mapping in `data/maps`
-1. (optional and discoraged) Add code to extract/generate it to:
-  * `lib/python/qmk/info.py`
-  * `lib/python/qmk/cli/generate/config_h.py`
-  * `lib/python/qmk/cli/generate/rules_mk.py`
-
-## Adding an option to info.json
-
-This section describes adding support for a `config.h`/`rules.mk` value to info.json.
-
-### Add it to the schema
-
-QMK maintains [jsonschema](https://json-schema.org/) files in `data/schemas`. The values that go into keyboard-specific `info.json` files are kept in `keyboard.jsonschema`. Any value you want to make available to end users to edit must go in here.
-
-In some cases you can simply add a new top-level key. Some examples to follow are `keyboard_name`, `maintainer`, `processor`, and `url`. This is appropriate when your option is self-contained and not directly related to other options.
-
-In other cases you should group like options together in an `object`. This is particularly true when adding support for a feature. Some examples to follow for this are `indicators`, `matrix_pins`, and `rgblight`. If you are not sure how to integrate your new option(s) [open an issue](https://github.com/qmk/qmk_firmware/issues/new?assignees=&labels=cli%2C+python&template=other_issues.md&title=) or [join #cli on Discord](https://discord.gg/heQPAgy) and start a conversation there.
-
-### Add a mapping
-
-In most cases you can add a simple mapping. These are maintained as JSON files in `data/mappings/info_config.json` and `data/mappings/info_rules.json`, and control mapping for `config.h` and `rules.mk`, respectively. Each mapping is keyed by the `config.h` or `rules.mk` variable, and the value is a hash with the following keys:
-
-* `info_key`: (required) The location within `info.json` for this value. See below.
-* `value_type`: (optional) Default `str`. The format for this variable's value. See below.
-* `to_json`: (optional) Default `true`. Set to `false` to exclude this mapping from info.json
-* `to_c`: (optional) Default `true`. Set to `false` to exclude this mapping from config.h
-* `warn_duplicate`: (optional) Default `true`. Set to `false` to turn off warning when a value exists in both places
-
-#### Info Key
-
-We use JSON dot notation to address variables within info.json. For example, to access `info_json["rgblight"]["split_count"]` I would specify `rgblight.split_count`. This allows you to address deeply nested keys with a simple string.
-
-Under the hood we use [Dotty Dict](https://dotty-dict.readthedocs.io/en/latest/), you can refer to that documentation for how these strings are converted to object access.
-
-#### Value Types
-
-By default we treat all values as simple strings. If your value is more complex you can use one of these types to intelligently parse the data:
-
-* `array`: A comma separated array of strings
-* `array.int`: A comma separated array of integers
-* `int`: An integer
-* `hex`: A number formatted as hex
-* `list`: A space separate array of strings
-* `mapping`: A hash of key/value pairs
-
-### Add code to extract it
-
-Most use cases can be solved by the mapping files described above. If yours can't you can instead write code to extract your config values.
-
-Whenever QMK generates a complete `info.json` it extracts information from `config.h` and `rules.mk`. You will need to add code for your new config value to `lib/python/qmk/info.py`. Typically this means adding a new `_extract_<feature>()` function and then calling your function in either `_extract_config_h()` or `_extract_rules_mk()`.
-
-If you are not sure how to edit this file or are not comfortable with Python [open an issue](https://github.com/qmk/qmk_firmware/issues/new?assignees=&labels=cli%2C+python&template=other_issues.md&title=) or [join #cli on Discord](https://discord.gg/heQPAgy) and someone can help you with this part.
-
-### Add code to generate it
-
-The final piece of the puzzle is providing your new option to the build system. This is done by generating two files:
-
-* `.build/obj_<keyboard>/src/info_config.h`
-* `.build/obj_<keyboard>/src/rules.mk`
-
-These two files are generated by the code here:
-
-* `lib/python/qmk/cli/generate/config_h.py`
-* `lib/python/qmk/cli/generate/rules_mk.py`
-
-For `config.h` values you'll need to write a function for your rule(s) and call that function in `generate_config_h()`.
-
-If you have a new top-level `info.json` key for `rules.mk` you can simply add your keys to `info_to_rules` at the top of `lib/python/qmk/cli/generate/rules_mk.py`. Otherwise you'll need to create a new if block for your feature in `generate_rules_mk()`.

docs/de/README.md

@@ -1,6 +1,7 @@
 # Quantum Mechanical Keyboard Firmware
 
 [![Aktuelle Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
+[![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
 [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
 [![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
 [![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)

docs/de/cli.md

@@ -88,14 +88,14 @@ qmk compile <configuratorExport.json>
 qmk compile -kb <keyboard_name> -km <keymap_name>
 ```
 
-## `qmk format-c`
+## `qmk cformat`
 
 Dieser Befehl formatiert C-Code im clang-Format. Benutze ihn ohne Argumente, um den core-Code zu formatieren, oder benutze Namen von Dateien in der CLI, um den Befehl auf bestimmte Dateien anzuwenden.
 
 **Anwendung**:
 
 ```
-qmk format-c [file1] [file2] [...] [fileN]
+qmk cformat [file1] [file2] [...] [fileN]
 ```
 
 ## `qmk config`
@@ -148,14 +148,14 @@ Dieser Befehl erstellt eine neue Keymap basierend auf einer existierenden Standa
 qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
 ```
 
-## `qmk format-py`
+## `qmk pyformat`
 
 Dieser Befehl formatiert Python-Code in `qmk_firmware`.
 
 **Anwendung**:
 
 ```
-qmk format-py
+qmk pyformat
 ```
 
 ## `qmk pytest`

docs/driver_installation_zadig.md

@@ -8,8 +8,8 @@ We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have
 
 ## Installation
 
-Put your keyboard into bootloader mode, either by hitting the `RESET` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic Lite](feature_bootmagic.md) docs for more details). Some boards use [Command](feature_command.md) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in.
-Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic Lite](feature_bootmagic.md) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure.
+Put your keyboard into bootloader mode, either by hitting the `RESET` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic](feature_bootmagic.md) docs for more details). Some boards use [Command](feature_command.md) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in.
+Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic Lite](feature_bootmagic.md#bootmagic-lite) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure.
 
 To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button.
 Alternatively, hold `BOOT` while inserting the USB cable.
@@ -30,38 +30,18 @@ If you find that you can no longer type with the keyboard, you may have accident
 
 ![A healthy keyboard as seen by Zadig](https://i.imgur.com/Hx0E5kC.png)
 
-Open the Device Manager, select **View → Devices by container**, and look for an entry with your keyboard's name.
+Open the Device Manager and look for a device that looks like your keyboard.
 
-![The board with the wrong driver installed, in Device Manager](https://i.imgur.com/o7WLvBl.png)
+![The board with the wrong driver installed, in Device Manager](https://i.imgur.com/L3wvX8f.png)
 
-Right-click each entry and hit **Uninstall device**. Make sure to tick **Delete the driver software for this device** first if it appears.
+Right-click it and hit **Uninstall device**. Make sure to tick **Delete the driver software for this device** first.
 
 ![The Device Uninstall dialog, with the "delete driver" checkbox ticked](https://i.imgur.com/aEs2RuA.png)
 
-Click **Action → Scan for hardware changes**. At this point, you should be able to type again. Double check in Zadig that the keyboard device(s) are using the `HidUsb` driver. If so, you're all done, and your board should be functional again! Otherwise, repeat this process until Zadig reports the correct driver.
+Click **Action → Scan for hardware changes**. At this point, you should be able to type again. Double check in Zadig that the keyboard device(s) are using the `HidUsb` driver. If so, you're all done, and your board should be functional again! Otherwise, repeat the process until Zadig reports the correct driver.
 
 ?> A full reboot of your computer may sometimes be necessary at this point, to get Windows to pick up the new driver.
 
-## Uninstallation
-
-Uninstallation of bootloader devices is a little more involved than installation.
-
-Open the Device Manager, select **View → Devices by container**, and look for the bootloader device. Match up the USB VID and PID in Zadig with one from [the table below](#list-of-known-bootloaders).
-
-Find the `Inf name` value in the Details tab of the device properties. This should generally be something like `oemXX.inf`:
-
-![Device properties showing the Inf name value](https://i.imgur.com/Bu4mk9m.png)
-
-Then, open a new Command Prompt window as an Administrator (type in `cmd` into the Start menu and press Ctrl+Shift+Enter). Run `pnputil /enum-drivers` to verify the `Inf name` matches the `Published Name` field of one of the entries:
-
-![pnputil output with matching driver highlighted](https://i.imgur.com/3RrSjzW.png)
-
-Run `pnputil /delete-driver oemXX.inf /uninstall`. This will delete the driver and remove it from any devices using it. Note that this will not uninstall the device itself.
-
-As with the previous section, this process may need to be repeated multiple times, as multiple drivers can be applicable to the same device.
-
-!> **WARNING:** Be *extremely careful* when doing this! You could potentially uninstall the driver for some other critical device. If you are unsure, double check the output of `/enum-drivers`, and omit the `/uninstall` flag when running `/delete-driver`.
-
 ## List of Known Bootloaders
 
 This is a list of known bootloader devices and their USB vendor and product IDs, as well as the correct driver to assign for flashing with QMK. Note that the usbser and HidUsb drivers are built in to Windows, and cannot be assigned with Zadig - if your device has an incorrect driver, you must use the Device Manager to uninstall it as described in the previous section.
@@ -95,4 +75,3 @@ The device name here is the name that appears in Zadig, and may not be what the
 |`stm32-dfu`  |STM32 BOOTLOADER              |`0483:DF11`   |WinUSB |
 |`kiibohd`    |Kiibohd DFU Bootloader        |`1C11:B007`   |WinUSB |
 |`stm32duino` |Maple 003                     |`1EAF:0003`   |WinUSB |
-|`qmk-hid`    |(keyboard name) Bootloader    |`03EB:2067`   |HidUsb |

docs/easy_maker.md

@@ -1,31 +0,0 @@
-# Easy Maker - Build One-Off Projects In Configurator
-
-Have you ever needed an easy way to program a controller, such as a Proton C or Teensy 2.0, for a one-off project you're building? QMK has you covered with the Easy Maker. Now you can create a firmware in minutes using QMK Configurator.
-
-There are different styles of Easy Maker available depending on your needs:
-
-* [Direct Pin](https://config.qmk.fm/#/?filter=ez_maker/direct) - Connect a single switch to a single pin
-* Direct Pin + Backlight (Coming Soon) - Like Direct Pin but dedicates a single pin to [Backlight](feature_backlight.md) control
-* Direct Pin + Numlock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED
-* Direct Pin + Capslock (Coming Soon) - Like Direct Pin but dedicates a single pin to the Numlock LED
-* Direct Pin + Encoder (Coming Soon) - Like Direct Pin but uses 2 pins to add a single rotary encoder
-
-## Quickstart
-
-The easiest way to get started is with the Direct Pin boards. This will assign a single key to each pin and you can short that pin to ground to activate it. Select your MCU from the Keyboard dropdown here:
-
-* <https://config.qmk.fm/#/?filter=ez_maker/direct>
-
-For more details see the [Direct Pin](#direct-pin) section.
-
-# Direct Pin
-
-As its name implies Direct Pin works by connecting one switch per pin. The other side of the switch should be connected to ground (VSS or GND.) You don't need any other components, your MCU has internal pull-up resistors so that the switch sensing can work.
-
-Here is a schematic showing how we connect a single button to pin A3 on a ProMicro:
-
-![Schematic diagram showing a ProMicro with a wire coming out of A3, connecting to the left side of a switch. Another wire comes out of the right side of the switch to connect to the Ground Plane.](https://i.imgur.com/JcDhZll.png)
-
-Once you have wired your switches you can assign keycodes to each pin and build a firmware by selecting the MCU you are using from the Keyboard dropdown. Use this link to show only Easy Maker Direct Pin:
-
-* <https://config.qmk.fm/#/?filter=ez_maker/direct>

docs/eeprom_driver.md

@@ -31,9 +31,6 @@ Currently QMK supports 24xx-series chips over I2C. As such, requires a working i
 `#define EXTERNAL_EEPROM_PAGE_SIZE`         | Page size of the EEPROM in bytes, as specified in the datasheet                     | 32
 `#define EXTERNAL_EEPROM_ADDRESS_SIZE`      | The number of bytes to transmit for the memory location within the EEPROM           | 2
 `#define EXTERNAL_EEPROM_WRITE_TIME`        | Write cycle time of the EEPROM, as specified in the datasheet                       | 5
-`#define EXTERNAL_EEPROM_WP_PIN`            | If defined the WP pin will be toggled appropriately when writing to the EEPROM.     | _none_
-
-Some I2C EEPROM manufacturers explicitly recommend against hardcoding the WP pin to ground. This is in order to protect the eeprom memory content during power-up/power-down/brown-out conditions at low voltage where the eeprom is still operational, but the i2c master output might be unpredictable. If a WP pin is configured, then having an external pull-up on the WP pin is recommended.
 
 Default values and extended descriptions can be found in `drivers/eeprom/eeprom_i2c.h`.
 

docs/es/README.md

@@ -1,6 +1,7 @@
 # Firmware Quantum Mechanical Keyboard
 
 [![Versión actual](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
+[![Estado de Build](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
 [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
 [![Estado de la documentación](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
 [![Contribuyentes en GitHub](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)

docs/es/hardware_avr.md

@@ -6,28 +6,26 @@ Si aún no lo has hecho, debes leer las [Pautas de teclados](hardware_keyboard_g
 
 ## Añadir tu Teclado AVR a QMK
 
-QMK tiene varias características para simplificar el trabajo con teclados AVR. Para la mayoría de los teclados no tienes que escribir ni una sola línea de código. Para empezar, ejecuta `qmk new-keyboard`:
+QMK tiene varias características para simplificar el trabajo con teclados AVR. Para la mayoría de los teclados no tienes que escribir ni una sola línea de código. Para empezar, ejecuta el archivo `util/new_keyboard.sh`:
 
 ```
-$ qmk new-keyboard
-Ψ Generating a new QMK keyboard directory
+$ ./util/new_keyboard.sh
+Generating a new QMK keyboard directory
 
-Keyboard Name: mycoolkeeb
-Keyboard Type:
-        1. avr
-        2. ps2avrgb
-Please enter your choice:  [1]
-Your Name: [John Smith]
-Ψ Copying base template files...
-Ψ Copying avr template files...
-Ψ Renaming keyboard.[ch] to mycoolkeeb.[ch]...
-Ψ Replacing %YEAR% with 2021...
-Ψ Replacing %KEYBOARD% with mycoolkeeb...
-Ψ Replacing %YOUR_NAME% with John Smith...
+Keyboard Name: mycoolkb
+Keyboard Type [avr]: 
+Your Name [John Smith]: 
 
-Ψ Created a new keyboard called mycoolkeeb.
-Ψ To start working on things, `cd` into keyboards/mycoolkeeb,
-Ψ or open the directory in your preferred text editor.
+Copying base template files... done
+Copying avr template files... done
+Renaming keyboard files... done
+Replacing %KEYBOARD% with mycoolkb... done
+Replacing %YOUR_NAME% with John Smith... done
+
+Created a new keyboard called mycoolkb.
+
+To start working on things, cd into keyboards/mycoolkb,
+or open the directory in your favourite text editor.
 ```
 
 Esto creará todos los archivos necesarios para tu nuevo teclado, y rellenará la configuración con valores predeterminados. Ahora sólo tienes que personalizarlo para tu teclado. 

docs/faq_debug.md

@@ -28,7 +28,7 @@ For compatible platforms, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) can
 
 Prefer a terminal based solution? [hid_listen](https://www.pjrc.com/teensy/hid_listen.html), provided by PJRC, can also be used to display debug messages. Prebuilt binaries for Windows,Linux,and MacOS are available.
 
-## Sending Your Own Debug Messages :id=debug-api
+## Sending Your Own Debug Messages
 
 Sometimes it's useful to print debug messages from within your [custom code](custom_quantum_functions.md). Doing so is pretty simple. Start by including `print.h` at the top of your file:
 
@@ -109,19 +109,6 @@ If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes
 
 You may need privileges to access the device an OS like Linux. Try `sudo hid_listen`.
 
-On many Linux distros you can avoid having to run hid_listen as root
-by creating a file called `/etc/udev/rules.d/70-hid-listen.rules` with
-the following content:
-
-```
-SUBSYSTEM=="hidraw", ATTRS{idVendor}=="abcd", ATTRS{idProduct}=="def1", TAG+="uaccess", RUN{builtin}+="uaccess"
-```
-
-Replace abcd and def1 with your keyboard's vendor and product id,
-letters must be lowercase. The `RUN{builtin}+="uaccess"` part is only
-needed for older distros.
-
-
 ## Can't Get Message on Console
 Check:
 - *hid_listen* finds your device. See above.

docs/faq_keymap.md

@@ -31,7 +31,7 @@ QMK has two features, Bootmagic and Command, which allow you to change the behav
 
 As a quick fix try holding down `Space`+`Backspace` while you plug in your keyboard. This will reset the stored settings on your keyboard, returning those keys to normal operation. If that doesn't work look here:
 
-* [Bootmagic Lite](feature_bootmagic.md)
+* [Bootmagic](feature_bootmagic.md)
 * [Command](feature_command.md) 
 
 ## The Menu Key Isn't Working

docs/feature_advanced_keycodes.md

@@ -2,165 +2,27 @@
 
 These allow you to combine a modifier with a keycode. When pressed, the keydown event for the modifier, then `kc` will be sent. On release, the keyup event for `kc`, then the modifier will be sent.
 
-|Key       |Aliases                           |Description                                           |
-|----------|----------------------------------|------------------------------------------------------|
-|`LCTL(kc)`|`C(kc)`                           |Hold Left Control and press `kc`                      |
-|`LSFT(kc)`|`S(kc)`                           |Hold Left Shift and press `kc`                        |
-|`LALT(kc)`|`A(kc)`, `LOPT(kc)`               |Hold Left Alt and press `kc`                          |
-|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`   |Hold Left GUI and press `kc`                          |
-|`RCTL(kc)`|                                  |Hold Right Control and press `kc`                     |
-|`RSFT(kc)`|                                  |Hold Right Shift and press `kc`                       |
-|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)`            |Hold Right Alt and press `kc`                         |
-|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`            |Hold Right GUI and press `kc`                         |
-|`LSG(kc)` |`SGUI(kc)`, `SCMD(kc)`, `SWIN(kc)`|Hold Left Shift and GUI and press `kc`                |
-|`LAG(kc)` |                                  |Hold Left Alt and Left GUI and press `kc`             |
-|`RSG(kc)` |                                  |Hold Right Shift and Right GUI and press `kc`         |
-|`RAG(kc)` |                                  |Hold Right Alt and Right GUI and press `kc`           |
-|`LCA(kc)` |                                  |Hold Left Control and Alt and press `kc`              |
-|`LSA(kc)` |                                  |Hold Left Shift and Left Alt and press `kc`           |
-|`RSA(kc)` |`SAGR(kc)`                        |Hold Right Shift and Right Alt (AltGr) and press `kc` |
-|`RCS(kc)` |                                  |Hold Right Control and Right Shift and press `kc`     |
-|`LCAG(kc)`|                                  |Hold Left Control, Alt and GUI and press `kc`         |
-|`MEH(kc)` |                                  |Hold Left Control, Shift and Alt and press `kc`       |
-|`HYPR(kc)`|                                  |Hold Left Control, Shift, Alt and GUI and press `kc`  |
+|Key       |Aliases                        |Description                                           |
+|----------|-------------------------------|------------------------------------------------------|
+|`LCTL(kc)`|`C(kc)`                        |Hold Left Control and press `kc`                      |
+|`LSFT(kc)`|`S(kc)`                        |Hold Left Shift and press `kc`                        |
+|`LALT(kc)`|`A(kc)`, `LOPT(kc)`            |Hold Left Alt and press `kc`                          |
+|`LGUI(kc)`|`G(kc)`, `LCMD(kc)`, `LWIN(kc)`|Hold Left GUI and press `kc`                          |
+|`RCTL(kc)`|                               |Hold Right Control and press `kc`                     |
+|`RSFT(kc)`|                               |Hold Right Shift and press `kc`                       |
+|`RALT(kc)`|`ROPT(kc)`, `ALGR(kc)`         |Hold Right Alt and press `kc`                         |
+|`RGUI(kc)`|`RCMD(kc)`, `LWIN(kc)`         |Hold Right GUI and press `kc`                         |
+|`SGUI(kc)`|`SCMD(kc)`, `SWIN(kc)`         |Hold Left Shift and GUI and press `kc`                |
+|`LCA(kc)` |                               |Hold Left Control and Alt and press `kc`              |
+|`LSA(kc)` |                               |Hold Left Shift and Left Alt and press `kc`           |
+|`RSA(kc)` |`SAGR(kc)`                     |Hold Right Shift and Right Alt (AltGr) and press `kc` |
+|`RCS(kc)` |                               |Hold Right Control and Right Shift and press `kc`     |
+|`LCAG(kc)`|                               |Hold Left Control, Alt and GUI and press `kc`         |
+|`MEH(kc)` |                               |Hold Left Control, Shift and Alt and press `kc`       |
+|`HYPR(kc)`|                               |Hold Left Control, Shift, Alt and GUI and press `kc`  |
 
 You can also chain them, for example `LCTL(LALT(KC_DEL))` or `C(A(KC_DEL))` makes a key that sends Control+Alt+Delete with a single keypress.
 
-# Checking Modifier State :id=checking-modifier-state
-
-The current modifier state can mainly be accessed with two functions: `get_mods()` for normal modifiers and modtaps and `get_oneshot_mods()` for one-shot modifiers (unless they're held, in which case they act like normal modifier keys).
-
-The presence of one or more specific modifiers in the current modifier state can be detected by ANDing the modifier state with a mod mask corresponding to the set of modifiers you want to match for. The reason why bitwise operators are used is that the modifier state is stored as a single byte in the format (GASC)<sub>R</sub>(GASC)<sub>L</sub>.
-
-Thus, to give an example, `01000010` would be the internal representation of LShift+RAlt.
-For more information on bitwise operators in C, click [here](https://en.wikipedia.org/wiki/Bitwise_operations_in_C) to open the Wikipedia page on the topic.
-
-In practice, this means that you can check whether a given modifier is active with `get_mods() & MOD_BIT(KC_<modifier>)` (see the [list of modifier keycodes](keycodes_basic.md#modifiers)) or with `get_mods() & MOD_MASK_<modifier>` if the difference between left and right hand modifiers is not important and you want to match both. Same thing can be done for one-shot modifiers if you replace `get_mods()` with `get_oneshot_mods()`.
-
-To check that *only* a specific set of mods is active at a time, AND the modifier state and your desired mod mask as explained above and compare the result to the mod mask itself: `get_mods() & <mod mask> == <mod mask>`.
-
-For example, let's say you want to trigger a piece of custom code if one-shot left control and one-shot left shift are on but every other one-shot mods are off. To do so, you can compose the desired mod mask by combining the mod bits for left control and shift with `(MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))` and then plug it in: `get_oneshot_mods & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT)) == (MOD_BIT(KC_LCTL) | MOD_BIT(KC_LSFT))`. Using `MOD_MASK_CS` instead for the mod bitmask would have forced you to press four modifier keys (both versions of control and shift) to fulfill the condition.
-
-The full list of mod masks is as follows:
-
-| Mod Mask Name      | Matching Modifiers                             |
-|--------------------|------------------------------------------------|
-| `MOD_MASK_CTRL`    | LCTRL       , RCTRL                            |
-| `MOD_MASK_SHIFT`   | LSHIFT      , RSHIFT                           |
-| `MOD_MASK_ALT`     | LALT        , RALT                             |
-| `MOD_MASK_GUI`     | LGUI        , RGUI                             |
-| `MOD_MASK_CS`      | CTRL        , SHIFT                            |
-| `MOD_MASK_CA`      | (L/R)CTRL   , (L/R)ALT                         |
-| `MOD_MASK_CG`      | (L/R)CTRL   , (L/R)GUI                         |
-| `MOD_MASK_SA`      | (L/R)SHIFT  , (L/R)ALT                         |
-| `MOD_MASK_SG`      | (L/R)SHIFT  , (L/R)GUI                         |
-| `MOD_MASK_AG`      | (L/R)ALT    , (L/R)GUI                         |
-| `MOD_MASK_CSA`     | (L/R)CTRL   , (L/R)SHIFT , (L/R)ALT            |
-| `MOD_MASK_CSG`     | (L/R)CTRL   , (L/R)SHIFT , (L/R)GUI            |
-| `MOD_MASK_CAG`     | (L/R)CTRL   , (L/R)ALT   , (L/R)GUI            |
-| `MOD_MASK_SAG`     | (L/R)SHIFT  , (L/R)ALT   , (L/R)GUI            |
-| `MOD_MASK_CSAG`    | (L/R)CTRL   , (L/R)SHIFT , (L/R)ALT , (L/R)GUI |
-
-Aside from accessing the currently active modifiers using `get_mods()`, there exists some other functions you can use to modify the modifier state, where the `mods` argument refers to the modifiers bitmask.
-
-* `add_mods(mods)`: Enable `mods` without affecting any other modifiers
-* `register_mods(mods)`: Like `add_mods` but send a keyboard report immediately.
-* `del_mods(mods)`: Disable `mods` without affecting any other modifiers
-* `unregister_mods(mods)`: Like `del_mods` but send a keyboard report immediately.
-* `set_mods(mods)`: Overwrite current modifier state with `mods`
-* `clear_mods()`: Reset the modifier state by disabling all modifiers
-
-Similarly, in addition to `get_oneshot_mods()`, there also exists these functions for one-shot mods:
-
-* `add_oneshot_mods(mods)`: Enable `mods` without affecting any other one-shot modifiers
-* `del_oneshot_mods(mods)`: Disable `mods` without affecting any other one-shot modifiers
-* `set_oneshot_mods(mods)`: Overwrite current one-shot modifier state with `mods`
-* `clear_oneshot_mods()`: Reset the one-shot modifier state by disabling all one-shot modifiers
-
-## Examples :id=examples
-
-The following examples use [advanced macro functions](feature_macros.md#advanced-macro-functions) which you can read more about in the [documentation page on macros](feature_macros.md).
-
-### Alt + Escape for Alt + Tab :id=alt-escape-for-alt-tab
-
-Simple example where chording Left Alt with `KC_ESC` makes it behave like `KC_TAB` for alt-tabbing between applications. This example strictly checks if only Left Alt is active, meaning you can't do Alt+Shift+Esc to switch between applications in reverse order. Also keep in mind that this removes the ability to trigger the actual Alt+Escape keyboard shortcut, though it keeps the ability to do AltGr+Escape.
-
-```c
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-    switch (keycode) {
-
-    case KC_ESC:
-        // Detect the activation of only Left Alt
-        if ((get_mods() & MOD_BIT(KC_LALT)) == MOD_BIT(KC_LALT)) {
-            if (record->event.pressed) {
-                // No need to register KC_LALT because it's already active.
-                // The Alt modifier will apply on this KC_TAB.
-                register_code(KC_TAB);
-            } else {
-                unregister_code(KC_TAB);
-            }
-            // Do not let QMK process the keycode further
-            return false;
-        }
-        // Else, let QMK process the KC_ESC keycode as usual
-        return true;
-
-    }
-    return true;
-};
-```
-
-### Shift + Backspace for Delete :id=shift-backspace-for-delete
-
-Advanced example where the original behaviour of shift is cancelled when chorded with `KC_BSPC` and is instead fully replaced by `KC_DEL`. Two main variables are created to make this work well: `mod_state` and `delkey_registered`. The first one stores the modifier state and is used to restore it after registering `KC_DEL`. The second variable is a boolean variable (true or false) which keeps track of the status of `KC_DEL` to manage the release of the whole Backspace/Delete key correctly.
-
-As opposed to the previous example, this doesn't use strict modifier checking. Pressing `KC_BSPC` while one or two shifts are active is enough to trigger this custom code, regardless of the state of other modifiers. That approach offers some perks: Ctrl+Shift+Backspace lets us delete the next word (Ctrl+Delete) and Ctrl+Alt+Shift+Backspace lets us execute the Ctrl+Alt+Del keyboard shortcut.
-
-```c
-// Initialize variable holding the binary
-// representation of active modifiers.
-uint8_t mod_state;
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-    // Store the current modifier state in the variable for later reference
-    mod_state = get_mods();
-    switch (keycode) {
-
-    case KC_BSPC:
-        {
-        // Initialize a boolean variable that keeps track
-        // of the delete key status: registered or not?
-        static bool delkey_registered;
-        if (record->event.pressed) {
-            // Detect the activation of either shift keys
-            if (mod_state & MOD_MASK_SHIFT) {
-                // First temporarily canceling both shifts so that
-                // shift isn't applied to the KC_DEL keycode
-                del_mods(MOD_MASK_SHIFT);
-                register_code(KC_DEL);
-                // Update the boolean variable to reflect the status of KC_DEL
-                delkey_registered = true;
-                // Reapplying modifier state so that the held shift key(s)
-                // still work even after having tapped the Backspace/Delete key.
-                set_mods(mod_state);
-                return false;
-            }
-        } else { // on release of KC_BSPC
-            // In case KC_DEL is still being sent even after the release of KC_BSPC
-            if (delkey_registered) {
-                unregister_code(KC_DEL);
-                delkey_registered = false;
-                return false;
-            }
-        }
-        // Let QMK process the KC_BSPC keycode as usual outside of shift
-        return true;
-    }
-
-    }
-    return true;
-};
-```
-
 # Legacy Content :id=legacy-content
 
 This page used to encompass a large set of features. We have moved many sections that used to be part of this page to their own pages. Everything below this point is simply a redirect so that people following old links on the web find what they're looking for.

docs/feature_audio.md

@@ -1,117 +1,21 @@
 # Audio
 
-Your keyboard can make sounds! If you've got a spare pin you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
+Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any AVR keyboard that allows access to certain PWM-capable pins, you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
 
-To activate this feature, add `AUDIO_ENABLE = yes` to your `rules.mk`.
+Up to two simultaneous audio voices are supported, one driven by timer 1 and another driven by timer 3.  The following pins can be defined as audio outputs in config.h:
 
-## AVR based boards
-On Atmega32U4 based boards, up to two simultaneous tones can be rendered.
-With one speaker connected to a PWM capable pin on PORTC driven by timer 3 and the other on one of the PWM pins on PORTB driven by timer 1.
+Timer 1:
+`#define B5_AUDIO`
+`#define B6_AUDIO`
+`#define B7_AUDIO`
 
-The following pins can be configured as audio outputs in `config.h` - for one speaker set either one out of:
+Timer 3:
+`#define C4_AUDIO`
+`#define C5_AUDIO`
+`#define C6_AUDIO`
 
-* `#define AUDIO_PIN C4`
-* `#define AUDIO_PIN C5`
-* `#define AUDIO_PIN C6`
-* `#define AUDIO_PIN B5`
-* `#define AUDIO_PIN B6`
-* `#define AUDIO_PIN B7`
+If you add `AUDIO_ENABLE = yes` to your `rules.mk`, there's a couple different sounds that will automatically be enabled without any other configuration:
 
-and *optionally*, for a second speaker, one of:
-* `#define AUDIO_PIN_ALT B5`
-* `#define AUDIO_PIN_ALT B6`
-* `#define AUDIO_PIN_ALT B7`
-
-### Wiring
-per speaker is - for example with a piezo buzzer - the black lead to Ground, and the red lead connected to the selected AUDIO_PIN for the primary; and similarly with AUDIO_PIN_ALT for the secondary.
-
-
-## ARM based boards
-for more technical details, see the notes on [Audio driver](audio_driver.md).
-
-<!-- because I'm not sure where to fit this in: https://waveeditonline.com/ -->
-### DAC (basic)
-Most STM32 MCUs have DAC peripherals, with a notable exception of the STM32F1xx series. Generally, the DAC peripheral drives pins A4 or A5. To enable DAC-based audio output on STM32 devices, add `AUDIO_DRIVER = dac_basic` to `rules.mk` and set in `config.h` either:
-
-`#define AUDIO_PIN A4` or `#define AUDIO_PIN A5`
-
-the other DAC channel can optionally be used with a secondary speaker, just set:
-
-`#define AUDIO_PIN_ALT A4` or `#define AUDIO_PIN_ALT A5`
-
-Do note though that the dac_basic driver is only capable of reproducing one tone per speaker/channel at a time, for more tones simultaneously, try the dac_additive driver.
-
-#### Wiring:
-for two piezos, for example configured as `AUDIO_PIN A4` and `AUDIO_PIN_ALT A5` would be: red lead to A4 and black to Ground, and similarly with the second one: A5 = red, and Ground = black
-
-another alternative is to drive *one* piezo with both DAC pins - for an extra "push".
-wiring red to A4 and black to A5 (or the other way round) and add `#define AUDIO_PIN_ALT_AS_NEGATIVE` to `config.h`
-
-##### Proton-C Example:
-The Proton-C comes (optionally) with one 'builtin' piezo, which is wired to A4+A5.
-For this board `config.h` would include these defines:
-
-```c
-#define AUDIO_PIN A5
-#define AUDIO_PIN_ALT A4
-#define AUDIO_PIN_ALT_AS_NEGATIVE
-```
-
-### DAC (additive)
-Another option, besides dac_basic (which produces sound through a square-wave), is to use the DAC to do additive wave synthesis.
-With a number of predefined wave-forms or by providing your own implementation to generate samples on the fly.
-To use this feature set `AUDIO_DRIVER = dac_additive` in your `rules.mk`, and select in `config.h` EITHER `#define AUDIO_PIN A4` or `#define AUDIO_PIN A5`.
-
-The used waveform *defaults* to sine, but others can be selected by adding one of the following defines to `config.h`:
-
-* `#define AUDIO_DAC_SAMPLE_WAVEFORM_SINE`
-* `#define AUDIO_DAC_SAMPLE_WAVEFORM_TRIANGLE`
-* `#define AUDIO_DAC_SAMPLE_WAVEFORM_TRAPEZOID`
-* `#define AUDIO_DAC_SAMPLE_WAVEFORM_SQUARE`
-
-Should you rather choose to generate and use your own sample-table with the DAC unit, implement `uint16_t dac_value_generate(void)` with your keyboard - for an example implementation see keyboards/planck/keymaps/synth_sample or keyboards/planck/keymaps/synth_wavetable
-
-
-### PWM (software)
-if the DAC pins are unavailable (or the MCU has no usable DAC at all, like STM32F1xx); PWM can be an alternative.
-Note that there is currently only one speaker/pin supported.
-
-set in `rules.mk`:
-
-`AUDIO_DRIVER = pwm_software` and in `config.h`: 
-`#define AUDIO_PIN C13` (can be any pin) to have the selected pin output a pwm signal, generated from a timer callback which toggles the pin in software.
-
-#### Wiring
-the usual piezo wiring: red goes to the selected AUDIO_PIN, black goes to ground.
-
-OR if you can chose to drive one piezo with two pins, for example `#define AUDIO_PIN B1`, `#define AUDIO_PIN_ALT B2` in `config.h`, with `#define AUDIO_PIN_ALT_AS_NEGATIVE` - then the red lead could go to B1, the black to B2.
-
-### PWM (hardware)
-STM32F1xx have to fall back to using PWM, but can do so in hardware; but again on currently only one speaker/pin.
-
-`AUDIO_DRIVER = pwm_hardware` in `rules.mk`, and in `config.h`:
-`#define AUDIO_PIN A8`
-`#define AUDIO_PWM_DRIVER PWMD1`
-`#define AUDIO_PWM_CHANNEL 1`
-(as well as `#define AUDIO_PWM_PAL_MODE 42` if you are on STM32F2 or larger)
-which will use Timer 1 to directly drive pin PA8 through the PWM hardware (TIM1_CH1 = PA8).
-Should you want to use the pwm-hardware on another pin and timer - be ready to dig into the STM32 data-sheet to pick the right TIMx_CHy and pin-alternate function.
-
-
-## Tone Multiplexing
-Since most drivers can only render one tone per speaker at a time (with the one exception: arm dac-additive) there also exists a "workaround-feature" that does time-slicing/multiplexing - which does what the name implies: cycle through a set of active tones (e.g. when playing chords in Music Mode) at a given rate, and put one tone at a time out through the one/few speakers that are available.
-
-To enable this feature, and configure a starting-rate, add the following defines to `config.h`:
-```c
-#define AUDIO_ENABLE_TONE_MULTIPLEXING
-#define AUDIO_TONE_MULTIPLEXING_RATE_DEFAULT 10
-```
-
-The audio core offers interface functions to get/set/change the tone multiplexing rate from within `keymap.c`.
-
-
-## Songs
-There's a couple of different sounds that will automatically be enabled without any other configuration:
 ```
 STARTUP_SONG // plays when the keyboard starts up (audio.c)
 GOODBYE_SONG // plays when you press the RESET key (quantum.c)
@@ -131,14 +35,12 @@ You can override the default songs by doing something like this in your `config.
 
 ```c
 #ifdef AUDIO_ENABLE
-#    define STARTUP_SONG SONG(STARTUP_SOUND)
+  #define STARTUP_SONG SONG(STARTUP_SOUND)
 #endif
 ```
 
 A full list of sounds can be found in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) - feel free to add your own to this list! All available notes can be seen in [quantum/audio/musical_notes.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/musical_notes.h).
 
-Additionally, if you with to maintain your own list of songs (such as ones that may be copyrighted) and not have them added to the repo, you can create a `user_song_list.h` file and place it in your keymap (or userspace) folder.  This file will be automatically included, it just needs to exist.
-
 To play a custom sound at a particular time, you can define a song like this (near the top of the file):
 
 ```c
@@ -165,60 +67,15 @@ The available keycodes for audio are:
 * `AU_OFF` - Turn Audio Feature off
 * `AU_TOG` - Toggle Audio Feature state
 
-!> These keycodes turn all of the audio functionality on and off.  Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely.
-
-## Audio Config
-
-| Settings                        | Default              | Description                                                                   |
-|---------------------------------|----------------------|-------------------------------------------------------------------------------|
-|`AUDIO_PIN`                      | *Not defined*        |Configures the pin that the speaker is connected to.                           |
-|`AUDIO_PIN_ALT`                  | *Not defined*        |Configures the pin for a second speaker or second pin connected to one speaker.|
-|`AUDIO_PIN_ALT_AS_NEGATIVE`      | *Not defined*        |Enables support for one speaker connected to two pins.                         |
-|`AUDIO_INIT_DELAY`               | *Not defined*        |Enables delay during startup song to accomidate for USB startup issues.        |
-|`AUDIO_ENABLE_TONE_MULTIPLEXING` | *Not defined*        |Enables time splicing/multiplexing to create multiple tones simutaneously.     |
-|`STARTUP_SONG`                   | `STARTUP_SOUND`      |Plays when the keyboard starts up (audio.c)                                    |
-|`GOODBYE_SONG`                   | `GOODBYE_SOUND`      |Plays when you press the RESET key (quantum.c)                                 |
-|`AG_NORM_SONG`                   | `AG_NORM_SOUND`      |Plays when you press AG_NORM (process_magic.c)                                 |
-|`AG_SWAP_SONG`                   | `AG_SWAP_SOUND`      |Plays when you press AG_SWAP (process_magic.c)                                 |
-|`CG_NORM_SONG`                   | `AG_NORM_SOUND`      |Plays when you press CG_NORM (process_magic.c)                                 |
-|`CG_SWAP_SONG`                   | `AG_SWAP_SOUND`      |Plays when you press CG_SWAP (process_magic.c)                                 |
-|`MUSIC_ON_SONG`                  | `MUSIC_ON_SOUND`     |Plays when music mode is activated (process_music.c)                           |
-|`MUSIC_OFF_SONG`                 | `MUSIC_OFF_SOUND`    |Plays when music mode is deactivated (process_music.c)                         |
-|`MIDI_ON_SONG`                   | `MUSIC_ON_SOUND`     |Plays when midi mode is activated (process_music.c)                            |
-|`MIDI_OFF_SONG`                  | `MUSIC_OFF_SOUND`    |Plays when midi mode is deactivated (process_music.c)                          |
-|`CHROMATIC_SONG`                 | `CHROMATIC_SOUND`    |Plays when the chromatic music mode is selected (process_music.c)              |
-|`GUITAR_SONG`                    | `GUITAR_SOUND`       |Plays when the guitar music mode is selected (process_music.c)                 |
-|`VIOLIN_SONG`                    | `VIOLIN_SOUND`       |Plays when the violin music mode is selected (process_music.c)                 |
-|`MAJOR_SONG`                     | `MAJOR_SOUND`        |Plays when the major music mode is selected (process_music.c)                  |
-|`DEFAULT_LAYER_SONGS`            | *Not defined*        |Plays song when switched default layers with [`set_single_persistent_default_layer(layer)`](ref_functions.md#setting-the-persistent-default-layer)(quantum.c)       |
-|`SENDSTRING_BELL`                | *Not defined*        |Plays chime when the "enter" ("\a") character is sent (send_string.c)          |
-
-## Tempo
-the 'speed' at which SONGs are played is dictated by the set Tempo, which is measured in beats-per-minute. Note lengths are defined relative to that.
-The initial/default tempo is set to 120 bpm, but can be configured by setting `TEMPO_DEFAULT` in `config.c`.
-There is also a set of functions to modify the tempo from within the user/keymap code:
-```c
-void audio_set_tempo(uint8_t tempo);
-void audio_increase_tempo(uint8_t tempo_change);
-void audio_decrease_tempo(uint8_t tempo_change);
-```
+!> These keycodes turn all of the audio functionality on and off.  Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely. 
 
 ## ARM Audio Volume
 
-For ARM devices, you can adjust the DAC sample values. If your board is too loud for you or your coworkers, you can set the max using `AUDIO_DAC_SAMPLE_MAX` in your `config.h`:
+For ARM devices, you can adjust the DAC sample values. If your board is too loud for you or your coworkers, you can set the max using `DAC_SAMPLE_MAX` in your `config.h`:
 
 ```c
-#define AUDIO_DAC_SAMPLE_MAX 4095U
+#define DAC_SAMPLE_MAX 65535U
 ```
-the DAC usually runs in 12Bit mode, hence a volume of 100% = 4095U
-
-Note: this only adjusts the volume aka 'works' if you stick to WAVEFORM_SQUARE, since its samples are generated on the fly - any other waveform uses a hardcoded/precomputed sample-buffer.
-
-## Voices
-Aka "audio effects", different ones can be enabled by setting in `config.h` these defines:
-`#define AUDIO_VOICES` to enable the feature, and `#define AUDIO_VOICE_DEFAULT something` to select a specific effect
-for details see quantum/audio/voices.h and .c
-
 
 ## Music Mode
 
@@ -319,7 +176,7 @@ You can configure the default, min and max frequencies, the stepping and built i
 |--------|---------------|-------------|
 | `AUDIO_CLICKY_FREQ_DEFAULT` | 440.0f | Sets the default/starting audio frequency for the clicky sounds. |
 | `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). |
-| `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the highest frequency. Too high may result in coworkers attacking you. |
+| `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. |
 | `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes.  This is a multiplicative factor.  The default steps the frequency up/down by a musical minor third.  |
 | `AUDIO_CLICKY_FREQ_RANDOMNESS`     |  0.05f |  Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical, and `1.0f` will make this sound much like the 90's computer screen scrolling/typing effect. | 
 | `AUDIO_CLICKY_DELAY_DURATION` | 1 | An integer note duration where 1 is 1/16th of the tempo, or a sixty-fourth note (see `quantum/audio/musical_notes.h` for implementation details). The main clicky effect will be delayed by this duration.  Adjusting this to values around 6-12 will help compensate for loud switches. |
@@ -329,7 +186,8 @@ You can configure the default, min and max frequencies, the stepping and built i
 
 ## MIDI Functionality
 
-See [MIDI](feature_midi.md)
+This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile.
+
 
 ## Audio Keycodes
 
@@ -346,3 +204,120 @@ See [MIDI](feature_midi.md)
 |`MU_OFF`        |         |Turns off Music Mode              |
 |`MU_TOG`        |         |Toggles Music Mode                |
 |`MU_MOD`        |         |Cycles through the music modes    |
+
+<!-- FIXME: this formatting needs work
+
+## Audio
+
+```c
+#ifdef AUDIO_ENABLE
+    AU_ON,
+    AU_OFF,
+    AU_TOG,
+
+    #ifdef FAUXCLICKY_ENABLE
+        FC_ON,
+        FC_OFF,
+        FC_TOG,
+    #endif
+
+    // Music mode on/off/toggle
+    MU_ON,
+    MU_OFF,
+    MU_TOG,
+
+    // Music voice iterate
+    MUV_IN,
+    MUV_DE,
+#endif
+```
+
+### Midi
+
+#if !MIDI_ENABLE_STRICT || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
+    MI_ON,  // send midi notes when music mode is enabled
+    MI_OFF, // don't send midi notes when music mode is enabled
+#endif
+
+MIDI_TONE_MIN,
+MIDI_TONE_MAX
+
+MI_C = MIDI_TONE_MIN,
+MI_Cs,
+MI_Db = MI_Cs,
+MI_D,
+MI_Ds,
+MI_Eb = MI_Ds,
+MI_E,
+MI_F,
+MI_Fs,
+MI_Gb = MI_Fs,
+MI_G,
+MI_Gs,
+MI_Ab = MI_Gs,
+MI_A,
+MI_As,
+MI_Bb = MI_As,
+MI_B,
+
+MIDI_TONE_KEYCODE_OCTAVES > 1
+
+where x = 1-5:
+MI_C_x,
+MI_Cs_x,
+MI_Db_x = MI_Cs_x,
+MI_D_x,
+MI_Ds_x,
+MI_Eb_x = MI_Ds_x,
+MI_E_x,
+MI_F_x,
+MI_Fs_x,
+MI_Gb_x = MI_Fs_x,
+MI_G_x,
+MI_Gs_x,
+MI_Ab_x = MI_Gs_x,
+MI_A_x,
+MI_As_x,
+MI_Bb_x = MI_As_x,
+MI_B_x,
+
+MI_OCT_Nx 1-2
+MI_OCT_x 0-7
+MIDI_OCTAVE_MIN = MI_OCT_N2,
+MIDI_OCTAVE_MAX = MI_OCT_7,
+MI_OCTD, // octave down
+MI_OCTU, // octave up
+
+MI_TRNS_Nx 1-6
+MI_TRNS_x 0-6
+MIDI_TRANSPOSE_MIN = MI_TRNS_N6,
+MIDI_TRANSPOSE_MAX = MI_TRNS_6,
+MI_TRNSD, // transpose down
+MI_TRNSU, // transpose up
+
+MI_VEL_x 1-10
+MIDI_VELOCITY_MIN = MI_VEL_1,
+MIDI_VELOCITY_MAX = MI_VEL_9,
+MI_VELD, // velocity down
+MI_VELU, // velocity up
+
+MI_CHx 1-16
+MIDI_CHANNEL_MIN = MI_CH1
+MIDI_CHANNEL_MAX = MI_CH16,
+MI_CHD, // previous channel
+MI_CHU, // next channel
+
+MI_ALLOFF, // all notes off
+
+MI_SUS, // sustain
+MI_PORT, // portamento
+MI_SOST, // sostenuto
+MI_SOFT, // soft pedal
+MI_LEG,  // legato
+
+MI_MOD, // modulation
+MI_MODSD, // decrease modulation speed
+MI_MODSU, // increase modulation speed
+#endif // MIDI_ADVANCED
+
+-->

docs/feature_auto_shift.md

@@ -109,33 +109,6 @@ Do not Auto Shift numeric keys, zero through nine.
 
 Do not Auto Shift alpha characters, which include A through Z.
 
-### Auto Shift Per Key 
-
-This is a function that allows you to determine which keys shold be autoshifted, much like the tap-hold keys. 
-
-The default function looks like this: 
-
-```c
-bool get_auto_shifted_key(uint16_t keycode, keyrecord_t *record) {
-    switch (keycode) {
-#    ifndef NO_AUTO_SHIFT_ALPHA
-        case KC_A ... KC_Z:
-#    endif
-#    ifndef NO_AUTO_SHIFT_NUMERIC
-        case KC_1 ... KC_0:
-#    endif
-#    ifndef NO_AUTO_SHIFT_SPECIAL
-        case KC_TAB:
-        case KC_MINUS ... KC_SLASH:
-        case KC_NONUS_BSLASH:
-#    endif
-            return true;
-    }
-    return false;
-}
-```
-This functionality is enabled by default, and does not need a define.
-
 ### AUTO_SHIFT_REPEAT (simple define)
 
 Enables keyrepeat.

docs/feature_backlight.md

@@ -62,17 +62,15 @@ Valid driver values are `pwm`, `software`, `custom` or `no`. See below for help
 
 To configure the backlighting, `#define` these in your `config.h`:
 
-|Define                       |Default           |Description                                                                                                      |
-|-----------------------------|------------------|-----------------------------------------------------------------------------------------------------------------|
-|`BACKLIGHT_PIN`              |*Not defined*     |The pin that controls the LED(s)                                                                                 |
-|`BACKLIGHT_LEVELS`           |`3`               |The number of brightness levels (maximum 31 excluding off)                                                       |
-|`BACKLIGHT_CAPS_LOCK`        |*Not defined*     |Enable Caps Lock indicator using backlight (for keyboards without dedicated LED)                                 |
-|`BACKLIGHT_BREATHING`        |*Not defined*     |Enable backlight breathing, if supported                                                                         |
-|`BREATHING_PERIOD`           |`6`               |The length of one backlight "breath" in seconds                                                                  |
-|`BACKLIGHT_ON_STATE`         |`1`               |The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low                            |
-|`BACKLIGHT_LIMIT_VAL`        |`255`             |The maximum duty cycle of the backlight -- `255` allows for full brightness, any lower will decrease the maximum.|
-|`BACKLIGHT_DEFAULT_LEVEL`    |`BACKLIGHT_LEVELS`|The default backlight level to use upon clearing the EEPROM                                                      |
-|`BACKLIGHT_DEFAULT_BREATHING`|*Not defined*     |Whether to enable backlight breathing upon clearing the EEPROM                                                   |
+| Define                 | Default       | Description                                                                                                       |
+|------------------------|---------------|-------------------------------------------------------------------------------------------------------------------|
+| `BACKLIGHT_PIN`        | *Not defined* | The pin that controls the LED(s)                                                                                  |
+| `BACKLIGHT_LEVELS`     | `3`           | The number of brightness levels (maximum 31 excluding off)                                                        |
+| `BACKLIGHT_CAPS_LOCK`  | *Not defined* | Enable Caps Lock indicator using backlight (for keyboards without dedicated LED)                                  |
+| `BACKLIGHT_BREATHING`  | *Not defined* | Enable backlight breathing, if supported                                                                          |
+| `BREATHING_PERIOD`     | `6`           | The length of one backlight "breath" in seconds                                                                   |
+| `BACKLIGHT_ON_STATE`   | `1`           | The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low                             |
+| `BACKLIGHT_LIMIT_VAL ` | `255`         | The maximum duty cycle of the backlight -- `255` allows for full brightness, any lower will decrease the maximum. |
 
 Unless you are designing your own keyboard, you generally should not need to change the `BACKLIGHT_PIN` or `BACKLIGHT_ON_STATE`.
 
@@ -95,18 +93,18 @@ BACKLIGHT_DRIVER = pwm
 
 On AVR boards, QMK automatically decides which driver to use according to the following table:
 
-|Backlight Pin|AT90USB64/128|AT90USB162|ATmega16/32U4|ATmega16/32U2|ATmega32A|ATmega328/P|
-|-------------|-------------|----------|-------------|-------------|---------|-----------|
-|`B1`         |             |          |             |             |         |Timer 1    |
-|`B2`         |             |          |             |             |         |Timer 1    |
-|`B5`         |Timer 1      |          |Timer 1      |             |         |           |
-|`B6`         |Timer 1      |          |Timer 1      |             |         |           |
-|`B7`         |Timer 1      |Timer 1   |Timer 1      |Timer 1      |         |           |
-|`C4`         |Timer 3      |          |             |             |         |           |
-|`C5`         |Timer 3      |Timer 1   |             |Timer 1      |         |           |
-|`C6`         |Timer 3      |Timer 1   |Timer 3      |Timer 1      |         |           |
-|`D4`         |             |          |             |             |Timer 1  |           |
-|`D5`         |             |          |             |             |Timer 1  |           |
+|Backlight Pin|AT90USB64/128|ATmega16/32U4|ATmega16/32U2|ATmega32A|ATmega328/P|
+|-------------|-------------|-------------|-------------|---------|-----------|
+|`B1`         |             |             |             |         |Timer 1    |
+|`B2`         |             |             |             |         |Timer 1    |
+|`B5`         |Timer 1      |Timer 1      |             |         |           |
+|`B6`         |Timer 1      |Timer 1      |             |         |           |
+|`B7`         |Timer 1      |Timer 1      |Timer 1      |         |           |
+|`C4`         |Timer 3      |             |             |         |           |
+|`C5`         |Timer 3      |             |Timer 1      |         |           |
+|`C6`         |Timer 3      |Timer 3      |Timer 1      |         |           |
+|`D4`         |             |             |             |Timer 1  |           |
+|`D5`         |             |             |             |Timer 1  |           |
 
 All other pins will use timer-assisted software PWM:
 
@@ -173,7 +171,7 @@ BACKLIGHT_DRIVER = software
 
 #### Multiple Backlight Pins :id=multiple-backlight-pins
 
-Most keyboards have only one backlight pin which controls all backlight LEDs (especially if the backlight is connected to a hardware PWM pin).
+Most keyboards have only one backlight pin which control all backlight LEDs (especially if the backlight is connected to an hardware PWM pin).
 In software PWM, it is possible to define multiple backlight pins, which will be turned on and off at the same time during the PWM duty cycle.
 
 This feature allows to set, for instance, the Caps Lock LED's (or any other controllable LED) brightness at the same level as the other LEDs of the backlight. This is useful if you have mapped Control in place of Caps Lock and you need the Caps Lock LED to be part of the backlight instead of being activated when Caps Lock is on, as it is usually wired to a separate pin from the backlight.

docs/feature_bootmagic.md

@@ -1,14 +1,135 @@
-# Bootmagic Lite :id=bootmagic-lite
+# Bootmagic
 
-The Bootmagic Lite feature that only handles jumping into the bootloader. This is great for boards that don't have a physical reset button, giving you a way to jump into the bootloader
+There are three separate but related features that allow you to change the behavior of your keyboard without reflashing. While each of them have similar functionality, it is accessed in different ways depending on how your keyboard is configured.
 
-On some keyboards Bootmagic Lite is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk` with:
+**Bootmagic** is a system for configuring your keyboard while it initializes. To trigger a Bootmagic command, hold down the Bootmagic key and one or more command keys.
+
+**Bootmagic Keycodes** are prefixed with `MAGIC_`, and allow you to access the Bootmagic functionality *after* your keyboard has initialized. To use the keycodes, assign them to your keymap as you would any other keycode.
+
+**Command**, formerly known as **Magic**, is another feature that allows you to control different aspects of your keyboard. While it shares some functionality with Bootmagic, it also allows you to do things that Bootmagic does not, such as printing version information to the console. For more information, see [Command](feature_command.md).
+
+On some keyboards Bootmagic is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk` with:
 
 ```make
-BOOTMAGIC_ENABLE = yes
+BOOTMAGIC_ENABLE = full
 ```
 
-?> You may see `lite` being used in place of `yes`.
+?> You may see `yes` being used in place of `full`, and this is okay. However, `yes` is deprecated, and ideally `full` (or `lite`) should be used instead.
+
+Additionally, you can use [Bootmagic Lite](#bootmagic-lite) (a scaled down, very basic version of Bootmagic) by adding the following to your `rules.mk` file:
+
+```make
+BOOTMAGIC_ENABLE = lite
+```
+
+## Hotkeys
+
+Hold down the Bootmagic key (Space by default) and the desired hotkey while plugging in your keyboard. For example, holding Space+`B` should cause it to enter the bootloader.
+
+|Hotkey            |Description                                  |
+|------------------|---------------------------------------------|
+|Escape            |Ignore Bootmagic configuration in EEPROM     |
+|`B`               |Enter the bootloader                         |
+|`D`               |Toggle debugging over serial                 |
+|`X`               |Toggle key matrix debugging                  |
+|`K`               |Toggle keyboard debugging                    |
+|`M`               |Toggle mouse debugging                       |
+|`L`               |Set "Left Hand" for EE_HANDS handedness      |
+|`R`               |Set "Right Hand" for EE_HANDS handedness     |
+|Backspace         |Clear the EEPROM                             |
+|Caps Lock         |Toggle treating Caps Lock as Left Control    |
+|Left Control      |Toggle swapping Caps Lock and Left Control   |
+|Left Alt          |Toggle swapping Left Alt and Left GUI        |
+|Right Alt         |Toggle swapping Right Alt and Right GUI      |
+|Left GUI          |Toggle the GUI keys (useful when gaming)     |
+|<code>&#96;</code>|Toggle swapping <code>&#96;</code> and Escape|
+|`\`               |Toggle swapping `\` and Backspace            |
+|`N`               |Toggle N-Key Rollover (NKRO)                 |
+|`0`               |Make layer 0 the default layer               |
+|`1`               |Make layer 1 the default layer               |
+|`2`               |Make layer 2 the default layer               |
+|`3`               |Make layer 3 the default layer               |
+|`4`               |Make layer 4 the default layer               |
+|`5`               |Make layer 5 the default layer               |
+|`6`               |Make layer 6 the default layer               |
+|`7`               |Make layer 7 the default layer               |
+
+## Keycodes :id=keycodes
+
+|Key                               |Aliases  |Description                                                               |
+|----------------------------------|---------|--------------------------------------------------------------------------|
+|`MAGIC_SWAP_CONTROL_CAPSLOCK`     |`CL_SWAP`|Swap Caps Lock and Left Control                                           |
+|`MAGIC_UNSWAP_CONTROL_CAPSLOCK`   |`CL_NORM`|Unswap Caps Lock and Left Control                                         |
+|`MAGIC_CAPSLOCK_TO_CONTROL`       |`CL_CTRL`|Treat Caps Lock as Control                                                |
+|`MAGIC_UNCAPSLOCK_TO_CONTROL`     |`CL_CAPS`|Stop treating Caps Lock as Control                                        |
+|`MAGIC_SWAP_LCTL_LGUI`            |`LCG_SWP`|Swap Left Control and GUI                                                 |
+|`MAGIC_UNSWAP_LCTL_LGUI`          |`LCG_NRM`|Unswap Left Control and GUI                                               |
+|`MAGIC_SWAP_RCTL_RGUI`            |`RCG_SWP`|Swap Right Control and GUI                                                |
+|`MAGIC_UNSWAP_RCTL_RGUI`          |`RCG_NRM`|Unswap Right Control and GUI                                              |
+|`MAGIC_SWAP_CTL_GUI`              |`CG_SWAP`|Swap Control and GUI on both sides                                        |
+|`MAGIC_UNSWAP_CTL_GUI`            |`CG_NORM`|Unswap Control and GUI on both sides                                      |
+|`MAGIC_TOGGLE_CTL_GUI`            |`CG_TOGG`|Toggle Control and GUI swap on both sides                                 |
+|`MAGIC_SWAP_LALT_LGUI`            |`LAG_SWP`|Swap Left Alt and GUI                                                     |
+|`MAGIC_UNSWAP_LALT_LGUI`          |`LAG_NRM`|Unswap Left Alt and GUI                                                   |
+|`MAGIC_SWAP_RALT_RGUI`            |`RAG_SWP`|Swap Right Alt and GUI                                                    |
+|`MAGIC_UNSWAP_RALT_RGUI`          |`RAG_NRM`|Unswap Right Alt and GUI                                                  |
+|`MAGIC_SWAP_ALT_GUI`              |`AG_SWAP`|Swap Alt and GUI on both sides                                            |
+|`MAGIC_UNSWAP_ALT_GUI`            |`AG_NORM`|Unswap Alt and GUI on both sides                                          |
+|`MAGIC_TOGGLE_ALT_GUI`            |`AG_TOGG`|Toggle Alt and GUI swap on both sides                                     |
+|`MAGIC_NO_GUI`                    |`GUI_OFF`|Disable the GUI keys                                                      |
+|`MAGIC_UNNO_GUI`                  |`GUI_ON` |Enable the GUI keys                                                       |
+|`MAGIC_SWAP_GRAVE_ESC`            |`GE_SWAP`|Swap <code>&#96;</code> and Escape                                        |
+|`MAGIC_UNSWAP_GRAVE_ESC`          |`GE_NORM`|Unswap <code>&#96;</code> and Escape                                      |
+|`MAGIC_SWAP_BACKSLASH_BACKSPACE`  |`BS_SWAP`|Swap `\` and Backspace                                                    |
+|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|`BS_NORM`|Unswap `\` and Backspace                                                  |
+|`MAGIC_HOST_NKRO`                 |`NK_ON`  |Enable N-key rollover                                                     |
+|`MAGIC_UNHOST_NKRO`               |`NK_OFF` |Disable N-key rollover                                                    |
+|`MAGIC_TOGGLE_NKRO`               |`NK_TOGG`|Toggle N-key rollover                                                     |
+|`MAGIC_EE_HANDS_LEFT`             |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) |
+|`MAGIC_EE_HANDS_RIGHT`            |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)|
+
+## Configuration
+
+If you would like to change the hotkey assignments for Bootmagic, `#define` these in your `config.h` at either the keyboard or keymap level.
+
+|Define                                  |Default      |Description                                        |
+|----------------------------------------|-------------|---------------------------------------------------|
+|`BOOTMAGIC_KEY_SALT`                    |`KC_SPACE`   |The Bootmagic key                                  |
+|`BOOTMAGIC_KEY_SKIP`                    |`KC_ESC`     |Ignore Bootmagic configuration in EEPROM           |
+|`BOOTMAGIC_KEY_EEPROM_CLEAR`            |`KC_BSPACE`  |Clear the EEPROM configuration                     |
+|`BOOTMAGIC_KEY_BOOTLOADER`              |`KC_B`       |Enter the bootloader                               |
+|`BOOTMAGIC_KEY_DEBUG_ENABLE`            |`KC_D`       |Toggle debugging over serial                       |
+|`BOOTMAGIC_KEY_DEBUG_MATRIX`            |`KC_X`       |Toggle matrix debugging                            |
+|`BOOTMAGIC_KEY_DEBUG_KEYBOARD`          |`KC_K`       |Toggle keyboard debugging                          |
+|`BOOTMAGIC_KEY_DEBUG_MOUSE`             |`KC_M`       |Toggle mouse debugging                             |
+|`BOOTMAGIC_KEY_EE_HANDS_LEFT`           |`KC_L`       |Set "Left Hand" for EE_HANDS handedness            |
+|`BOOTMAGIC_KEY_EE_HANDS_RIGHT`          |`KC_R`       |Set "Right Hand" for EE_HANDS handedness           |
+|`BOOTMAGIC_KEY_SWAP_CONTROL_CAPSLOCK`   |`KC_LCTRL`   |Swap Left Control and Caps Lock                    |
+|`BOOTMAGIC_KEY_CAPSLOCK_TO_CONTROL`     |`KC_CAPSLOCK`|Toggle treating Caps Lock as Left Control          |
+|`BOOTMAGIC_KEY_SWAP_LALT_LGUI`          |`KC_LALT`    |Toggle swapping Left Alt and Left GUI (for macOS)  |
+|`BOOTMAGIC_KEY_SWAP_RALT_RGUI`          |`KC_RALT`    |Toggle swapping Right Alt and Right GUI (for macOS)|
+|`BOOTMAGIC_KEY_NO_GUI`                  |`KC_LGUI`    |Toggle the GUI keys (useful when gaming)           |
+|`BOOTMAGIC_KEY_SWAP_GRAVE_ESC`          |`KC_GRAVE`   |Toggle swapping <code>&#96;</code> and Escape      |
+|`BOOTMAGIC_KEY_SWAP_BACKSLASH_BACKSPACE`|`KC_BSLASH`  |Toggle swapping `\` and Backspace                  |
+|`BOOTMAGIC_HOST_NKRO`                   |`KC_N`       |Toggle N-Key Rollover (NKRO)                       |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_0`         |`KC_0`       |Make layer 0 the default layer                     |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_1`         |`KC_1`       |Make layer 1 the default layer                     |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_2`         |`KC_2`       |Make layer 2 the default layer                     |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_3`         |`KC_3`       |Make layer 3 the default layer                     |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_4`         |`KC_4`       |Make layer 4 the default layer                     |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_5`         |`KC_5`       |Make layer 5 the default layer                     |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_6`         |`KC_6`       |Make layer 6 the default layer                     |
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_7`         |`KC_7`       |Make layer 7 the default layer                     |
+
+# Bootmagic Lite :id=bootmagic-lite
+
+In addition to the full blown Bootmagic feature, is the Bootmagic Lite feature that only handles jumping into the bootloader. This is great for boards that don't have a physical reset button but you need a way to jump into the bootloader, and don't want to deal with the headache that Bootmagic can cause.
+
+To enable this version of Bootmagic, you need to enable it in your `rules.mk` with:
+
+```make
+BOOTMAGIC_ENABLE = lite
+```
 
 Additionally, you may want to specify which key to use. This is especially useful for keyboards that have unusual matrices. To do so, you need to specify the row and column of the key that you want to use. Add these entries to your `config.h` file:
 
@@ -21,11 +142,11 @@ By default, these are set to 0 and 0, which is usually the "ESC" key on a majori
 
 And to trigger the bootloader, you hold this key down when plugging the keyboard in. Just the single key.
 
-!> Using Bootmagic Lite will **always reset** the EEPROM, so you will lose any settings that have been saved.
+!> Using bootmagic lite will **always reset** the EEPROM, so you will lose any settings that have been saved.
 
 ## Split Keyboards
 
-When handedness is predetermined via an option like `SPLIT_HAND_PIN`, you might need to configure a different key between halves. To do so, add these entries to your `config.h` file:
+When handedness is predetermined via an option like `SPLIT_HAND_PIN`, you might need to configure a different key between halves. This To do so, add these entries to your `config.h` file:
 
 ```c
 #define BOOTMAGIC_LITE_ROW_RIGHT 4
@@ -53,10 +174,4 @@ void bootmagic_lite(void) {
 }
 ```
 
-You can additional feature here. For instance, resetting the EEPROM or requiring additional keys to be pressed to trigger Bootmagic Lite. Keep in mind that `bootmagic_lite` is called before a majority of features are initialized in the firmware.
-
-## Addenda
-
-To manipulate settings that were formerly configured through the now-deprecated full Bootmagic feature, see [Magic Keycodes](keycodes_magic.md).
-
-The Command feature, formerly known as Magic, also allows you to control different aspects of your keyboard. While it shares some functionality with Magic Keycodes, it also allows you to do things that Magic Keycodes cannot, such as printing version information to the console. For more information, see [Command](feature_command.md).
+You can additional feature here. For instance, resetting the eeprom or requiring additional keys to be pressed to trigger bootmagic. Keep in mind that `bootmagic_lite` is called before a majority of features are initialized in the firmware.

docs/feature_combo.md

@@ -1,39 +1,24 @@
 # Combos
 
-The Combo feature is a chording type solution for adding custom actions. It lets you hit multiple keys at once and produce a different effect. For instance, hitting `A` and `S` within the combo term would hit `ESC` instead, or have it perform even more complex tasks.
+The Combo feature is a chording type solution for adding custom actions.  It lets you hit multiple keys at once and produce a different effect.  For instance, hitting `A` and `S` within the tapping term would hit `ESC` instead, or have it perform even more complex tasks.
 
 To enable this feature, you need to add `COMBO_ENABLE = yes` to your `rules.mk`.
 
-Additionally, in your `config.h`, you'll need to specify the number of combos that you'll be using, by adding `#define COMBO_COUNT 1` (replacing 1 with the number that you're using). It is also possible to not define this and instead set the variable `COMBO_LEN` yourself. There's a trick where we don't need to think about this variable at all. More on this later.
+Additionally, in your `config.h`, you'll need to specify the number of combos that you'll be using, by adding `#define COMBO_COUNT 1` (replacing 1 with the number that you're using).
+<!-- At this time, this is necessary -->
 
+Also, by default, the tapping term for the Combos is set to the same value as `TAPPING_TERM` (200 by default on most boards). But you can specify a different value by defining it in your `config.h`.  For instance: `#define COMBO_TERM 300` would set the time out period for combos to 300ms.
 
-Then, in your `keymap.c` file, you'll need to define a sequence of keys, terminated with `COMBO_END`, and a structure to list the combination of keys, and its resulting action.
+Then, your `keymap.c` file, you'll need to define a sequence of keys, terminated with `COMBO_END`, and a structure to list the combination of keys, and it's resulting action.
 
 ```c
-const uint16_t PROGMEM test_combo1[] = {KC_A, KC_B, COMBO_END};
-const uint16_t PROGMEM test_combo2[] = {KC_C, KC_D, COMBO_END};
-combo_t key_combos[COMBO_COUNT] = {
-    COMBO(test_combo1, KC_ESC),
-    COMBO(test_combo2, LCTL(KC_Z)), // keycodes with modifiers are possible too!
-};
+const uint16_t PROGMEM test_combo[] = {KC_A, KC_B, COMBO_END};
+combo_t key_combos[COMBO_COUNT] = {COMBO(test_combo, KC_ESC)};
 ```
 
-This will send "Escape" if you hit the A and B keys, and Ctrl+Z when you hit the C and D keys.
+This will send "Escape" if you hit the A and B keys.
 
-As of [PR#8591](https://github.com/qmk/qmk_firmware/pull/8591/), it is possible to fire combos from ModTap keys and LayerTap keys. So in the above example you could have keys `LSFT_T(KC_A)` and `LT(_LAYER, KC_B)` and it would work. So Home Row Mods and Home Row Combos at same time is now a thing!
-
-It is also now possible to overlap combos. Before, with the example below both combos would activate when all three keys were pressed. Now only the three key combo will activate.
-
-```c
-const uint16_t PROGMEM test_combo1[] = {LSFT_T(KC_A), LT(_LAYER, KC_B), COMBO_END};
-const uint16_t PROGMEM test_combo2[] = {LSFT_T(KC_A), LT(_LAYER, KC_B), KC_C, COMBO_END};
-combo_t key_combos[COMBO_COUNT] = {
-    COMBO(test_combo1, KC_ESC)
-    COMBO(test_combo2, KC_TAB)
-};
-```
-
-Executing more complex keycodes like ModTaps and LayerTaps is now also possible.
+!> This method only supports [basic keycodes](keycodes_basic.md). See the examples for more control.
 
 ## Examples
 
@@ -42,68 +27,63 @@ If you want to add a list, then you'd use something like this:
 ```c
 enum combos {
   AB_ESC,
-  JK_TAB,
-  QW_SFT,
-  SD_LAYER,
+  JK_TAB
 };
 
 const uint16_t PROGMEM ab_combo[] = {KC_A, KC_B, COMBO_END};
 const uint16_t PROGMEM jk_combo[] = {KC_J, KC_K, COMBO_END};
-const uint16_t PROGMEM qw_combo[] = {KC_Q, KC_W, COMBO_END};
-const uint16_t PROGMEM sd_combo[] = {KC_S, KC_D, COMBO_END};
 
 combo_t key_combos[COMBO_COUNT] = {
   [AB_ESC] = COMBO(ab_combo, KC_ESC),
-  [JK_TAB] = COMBO(jk_combo, KC_TAB),
-  [QW_SFT] = COMBO(qw_combo, KC_LSFT)
-  [SD_LAYER] = COMBO(layer_combo, MO(_LAYER)),
+  [JK_TAB] = COMBO(jk_combo, KC_TAB)
 };
 ```
 
 For a more complicated implementation, you can use the `process_combo_event` function to add custom handling.
-Additionally, this example shows how you can leave `COMBO_COUNT` undefined.
 
 ```c
 enum combo_events {
-  EM_EMAIL,
-  BSPC_LSFT_CLEAR,
-  COMBO_LENGTH
+  ZC_COPY,
+  XV_PASTE
 };
-uint16_t COMBO_LEN = COMBO_LENGTH; // remove the COMBO_COUNT define and use this instead!
 
-const uint16_t PROGMEM email_combo[] = {KC_E, KC_M, COMBO_END};
-const uint16_t PROGMEM clear_line_combo[] = {KC_BSPC, KC_LSFT, COMBO_END};
+const uint16_t PROGMEM copy_combo[] = {KC_Z, KC_C, COMBO_END};
+const uint16_t PROGMEM paste_combo[] = {KC_X, KC_V, COMBO_END};
 
-combo_t key_combos[] = {
-  [EM_EMAIL] = COMBO_ACTION(email_combo),
-  [BSPC_LSFT_CLEAR] = COMBO_ACTION(clear_line_combo),
+combo_t key_combos[COMBO_COUNT] = {
+  [ZC_COPY] = COMBO_ACTION(copy_combo),
+  [XV_PASTE] = COMBO_ACTION(paste_combo),
 };
-/* COMBO_ACTION(x) is same as COMBO(x, KC_NO) */
 
 void process_combo_event(uint16_t combo_index, bool pressed) {
   switch(combo_index) {
-    case EM_EMAIL:
+    case ZC_COPY:
       if (pressed) {
-        SEND_STRING("john.doe@example.com");
+        tap_code16(LCTL(KC_C));
       }
       break;
-    case BSPC_LSFT_CLEAR:
+    case XV_PASTE:
       if (pressed) {
-        tap_code16(KC_END);
-        tap_code16(S(KC_HOME));
-        tap_code16(KC_BSPC);
+        tap_code16(LCTL(KC_V));
       }
       break;
   }
 }
 ```
 
-This will send "john.doe@example.com" if you chord E and M together, and clear the current line with Backspace and Left-Shift. You could change this to do stuff like play sounds or change settings.
+This will send Ctrl+C if you hit Z and C, and Ctrl+V if you hit X and V.  But you could change this to do stuff like change layers, play sounds, or change settings.
 
-It is worth noting that `COMBO_ACTION`s are not needed anymore. As of [PR#8591](https://github.com/qmk/qmk_firmware/pull/8591/), it is possible to run your own custom keycodes from combos. Just define the custom keycode, program its functionality in `process_record_user`, and define a combo with `COMBO(<key_array>, <your_custom_keycode>)`.
+## Additional Configuration
 
-## Keycodes
-You can enable, disable and toggle the Combo feature on the fly. This is useful if you need to disable them temporarily, such as for a game. The following keycodes are available for use in your `keymap.c`
+If you're using long combos, or even longer combos, you may run into issues with this, as the structure may not be large enough to accommodate what you're doing.
+
+In this case, you can add either `#define EXTRA_LONG_COMBOS` or `#define EXTRA_EXTRA_LONG_COMBOS` in your `config.h` file.
+
+You may also be able to enable action keys by defining `COMBO_ALLOW_ACTION_KEYS`.
+
+## Keycodes 
+
+You can enable, disable and toggle the Combo feature on the fly.  This is useful if you need to disable them temporarily, such as for a game. 
 
 |Keycode   |Description                      |
 |----------|---------------------------------|
@@ -111,187 +91,6 @@ You can enable, disable and toggle the Combo feature on the fly. This is useful
 |`CMB_OFF` |Turns off Combo feature          |
 |`CMB_TOG` |Toggles Combo feature on and off |
 
-# Advanced Configuration
-These configuration settings can be set in your `config.h` file.
-
-## Combo Term
-By default, the timeout for the Combos to be recognized is set to 50ms. This can be changed if accidental combo misfires are happening or if you're having difficulties pressing keys at the same time. For instance, `#define COMBO_TERM 40` would set the timeout period for combos to 40ms.
-
-## Buffer and state sizes
-If you're using long combos, or you have a lot of overlapping combos, you may run into issues with this, as the buffers may not be large enough to accommodate what you're doing. In this case, you can configure the sizes of the buffers used. Be aware, larger combo sizes and larger buffers will increase memory usage!
-
-To configure the amount of keys a combo can be composed of, change the following:
-
-| Keys | Define to be set                  |
-|------|-----------------------------------|
-| 6    | `#define EXTRA_SHORT_COMBOS`      |
-| 8    | QMK Default                       |
-| 16   | `#define EXTRA_LONG_COMBOS`       |
-| 32   | `#define EXTRA_EXTRA_LONG_COMBOS` |
-
-Defining `EXTRA_SHORT_COMBOS` combines a combo's internal state into just one byte. This can, in some cases, save some memory. If it doesn't, no point using it. If you do, you also have to make sure you don't define combos with more than 6 keys.
-
-Processing combos has two buffers, one for the key presses, another for the combos being activated. Use the following options to configure the sizes of these buffers:
-
-| Define                              | Default                                              |
-|-------------------------------------|------------------------------------------------------|
-| `#define COMBO_KEY_BUFFER_LENGTH 8` | 8 (the key amount `(EXTRA_)EXTRA_LONG_COMBOS` gives) |
-| `#define COMBO_BUFFER_LENGTH 4`     | 4                                                    |
-
-## Modifier Combos
-If a combo resolves to a Modifier, the window for processing the combo can be extended independently from normal combos. By default, this is disabled but can be enabled with `#define COMBO_MUST_HOLD_MODS`, and the time window can be configured with `#define COMBO_HOLD_TERM 150` (default: `TAPPING_TERM`). With `COMBO_MUST_HOLD_MODS`, you cannot tap the combo any more which makes the combo less prone to misfires.
-
-## Per Combo Timing, Holding and Tapping
-For each combo, it is possible to configure the time window it has to pressed in, if it needs to be held down, or if it needs to be tapped.
-
-For example, tap-only combos are useful if any (or all) of the underlying keys is a Mod-Tap or a Layer-Tap key. When you tap the combo, you get the combo result. When you press the combo and hold it down, the combo doesn't actually activate. Instead the keys are processed separately as if the combo wasn't even there.
-
-In order to use these features, the following configuration options and functions need to be defined. Coming up with useful timings and configuration is left as an exercise for the reader.
-
-| Config Flag                 | Function                                                  | Description                                                                                            |
-|-----------------------------|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
-| `COMBO_TERM_PER_COMBO`      | uint16_t get_combo_term(uint16_t index, combo_t \*combo)  | Optional per-combo timeout window. (default: `COMBO_TERM`)                                             |
-| `COMBO_MUST_HOLD_PER_COMBO` | bool get_combo_must_hold(uint16_t index, combo_t \*combo) | Controls if a given combo should fire immediately on tap or if it needs to be held. (default: `false`) |
-| `COMBO_MUST_TAP_PER_COMBO`  | bool get_combo_must_tap(uint16_t index, combo_t \*combo)  | Controls if a given combo should fire only if tapped within `COMBO_HOLD_TERM`. (default: `false`)      |
-
-Examples:
-```c
-uint16_t get_combo_term(uint16_t index, combo_t *combo) {
-    // decide by combo->keycode
-    switch (combo->keycode) {
-        case KC_X:
-            return 50;
-    }
-
-    // or with combo index, i.e. its name from enum.
-    switch (index) {
-        case COMBO_NAME_HERE:
-            return 9001;
-    }
-
-    // And if you're feeling adventurous, you can even decide by the keys in the chord,
-    // i.e. the exact array of keys you defined for the combo.
-    // This can be useful if your combos have a common key and you want to apply the
-    // same combo term for all of them.
-    if (combo->keys[0] == KC_ENTER) { // if first key in the array is KC_ENTER
-        return 150;
-    }
-
-    return COMBO_TERM;
-}
-
-bool get_combo_must_hold(uint16_t index, combo_t *combo) {
-    // Same as above, decide by keycode, the combo index, or by the keys in the chord.
-
-    if (KEYCODE_IS_MOD(combo->keycode) || 
-        (combo->keycode >= QK_MOMENTARY && combo->keycode <= QK_MOMENTARY_MAX) // MO(kc) keycodes
-        ) {
-        return true;
-    }
-
-    switch (index) {
-        case COMBO_NAME_HERE:
-            return true;
-    }
-
-    return false;
-}
-
-bool get_combo_must_tap(uint16_t index, combo_t *combo) {
-    // If you want all combos to be tap-only, just uncomment the next line
-    // return true
-
-    // If you want *all* combos, that have Mod-Tap/Layer-Tap/Momentary keys in its chord, to be tap-only, this is for you:
-    uint16_t key;
-    uint8_t idx = 0;
-    while ((key = pgm_read_word(&combo->keys[idx])) != COMBO_END) {
-        switch (key) {
-            case QK_MOD_TAP...QK_MOD_TAP_MAX:
-            case QK_LAYER_TAP...QK_LAYER_TAP_MAX:
-            case QK_MOMENTARY...QK_MOMENTARY_MAX:
-                return true;
-        }
-        idx += 1;
-    }
-    return false;
-
-}
-```
-
-## Variable Length Combos
-If you leave `COMBO_COUNT` undefined in `config.h`, it allows you to programmatically declare the size of the Combo data structure and avoid updating `COMBO_COUNT`. Instead a variable called `COMBO_LEN` has to be set. It can be set with something similar to the following in `keymap.c`: `uint16_t COMBO_LEN = sizeof(key_combos) / sizeof(key_combos[0]);` or by adding `COMBO_LENGTH` as the *last* entry in the combo enum and then `uint16_t COMBO_LEN = COMBO_LENGTH;` as such:
-```c
-enum myCombos {
-    ...,
-    COMBO_LENGTH
-};
-uint16_t COMBO_LEN = COMBO_LENGTH;
-```
-Regardless of the method used to declare `COMBO_LEN`, this also requires to convert the `combo_t key_combos[COMBO_COUNT] = {...};` line to `combo_t key_combos[] = {...};`.
-
-
-## Combo timer
-
-Normally, the timer is started on the first key press and then reset on every subsequent key press within the `COMBO_TERM`.
-Inputting combos is relaxed like this, but also slightly more prone to accidental misfires.
-
-The next two options alter the behaviour of the timer.
-
-### `#define COMBO_STRICT_TIMER`
-
-With `COMBO_STRICT_TIMER`, the timer is started only on the first key press.
-Inputting combos is now less relaxed; you need to make sure the full chord is pressed within the `COMBO_TERM`.
-Misfires are less common but if you type multiple combos fast, there is a
-chance that the latter ones might not activate properly.
-
-### `#define COMBO_NO_TIMER`
-
-By defining `COMBO_NO_TIMER`, the timer is disabled completely and combos are activated on the first key release.
-This also disables the "must hold" functionalities as they just wouldn't work at all.
-
-## Customizable key releases
-
-By defining `COMBO_PROCESS_KEY_RELEASE` and implementing the function `bool process_combo_key_release(uint16_t combo_index, combo_t *combo, uint8_t key_index, uint16_t keycode)`, you can run your custom code on each key release after a combo was activated. For example you could change the RGB colors, activate haptics, or alter the modifiers.
-
-You can also release a combo early by returning `true` from the function.
-
-Here's an example where a combo resolves to two modifiers, and on key releases the modifiers are unregistered one by one, depending on which key was released.
-
-```c
-enum combos {
-  AB_MODS,
-  COMBO_LENGTH
-};
-uint16_t COMBO_LEN = COMBO_LENGTH;
-
-const uint16_t PROGMEM ab_combo[] = {KC_A, KC_B, COMBO_END};
-
-combo_t key_combos[] = {
-  [AB_MODS] = COMBO(ab_combo, LCTL(KC_LSFT)),
-};
-
-bool process_combo_key_release(uint16_t combo_index, combo_t *combo, uint8_t key_index, uint16_t keycode) {
-    switch (combo_index) {
-        case AB_MODS:
-            switch(keycode) {
-                case KC_A:
-                    unregister_mods(MOD_MASK_CTRL);
-                    break;
-                case KC_B:
-                    unregister_mods(MOD_MASK_SHIFT);
-                    break;
-            }
-            return false; // do not release combo
-    }
-    return false;
-}
-```
-## Layer independent combos
-
-If you, for example, use multiple base layers for different key layouts, one for QWERTY, and another one for Colemak, you might want your combos to work from the same key positions on all layers. Defining the same combos again for another layout is redundant and takes more memory. The solution is to just check the keycodes from one layer.
-
-With `#define COMBO_ONLY_FROM_LAYER _LAYER_A` the combos' keys are always checked from layer `_LAYER_A` even though the active layer would be `_LAYER_B`.
-
 ## User callbacks
 
 In addition to the keycodes, there are a few functions that you can use to set the status, or check it:
@@ -302,28 +101,3 @@ In addition to the keycodes, there are a few functions that you can use to set t
 | `combo_disable()`    | Disables the combo feature, and clears the combo buffer |
 | `combo_toggle()`     | Toggles the state of the combo feature                  |
 | `is_combo_enabled()` | Returns the status of the combo feature state (true or false) |
-
-
-# Dictionary Management
-
-Having 3 places to update when adding new combos or altering old ones does become cumbersome when you have a lot of combos. We can alleviate this with some magic! ... If you consider C macros magic.
-First, you need to add `VPATH += keyboards/gboards` to your `rules.mk`. Next, include the file `g/keymap_combo.h` in your `keymap.c`.
-
-!> This functionality uses the same `process_combo_event` function as `COMBO_ACTION` macros do, so you cannot use the function yourself in your keymap. Instead, you have to define the `case`s of the `switch` statement by themselves within `inject.h`, which `g/keymap_combo.h` will then include into the function.
-
-Then, write your combos in `combos.def` file in the following manner:
-
-```c
-//   name     result    chord keys
-COMB(AB_ESC,   KC_ESC,   KC_A, KC_B)
-COMB(JK_TAB,   KC_TAB,   KC_J, KC_K)
-COMB(JKL_SPC,  KC_SPC,   KC_J, KC_K, KC_L)
-COMB(BSSL_CLR, KC_NO,    KC_BSPC, KC_LSFT) // using KC_NO as the resulting keycode is the same as COMBO_ACTION before.
-COMB(QW_UNDO,  C(KC_Z),  KC_Q, KC_W)
-SUBS(TH_THE,   "the",    KC_T, KC_H) // SUBS uses SEND_STRING to output the given string.
-...
-```
-
-Now, you can update only one place to add or alter combos. You don't even need to remember to update the `COMBO_COUNT` or the `COMBO_LEN` variables at all. Everything is taken care of. Magic!
-
-For small to huge ready made dictionaries of combos, you can check out http://combos.gboards.ca/.

docs/feature_command.md

@@ -1,6 +1,6 @@
 # Command
 
-Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic Lite](feature_bootmagic.md). There is a lot of overlap between this functionality and the [Magic Keycodes](keycodes_magic.md). Wherever possible we encourage you to use that feature instead of Command.
+Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](feature_bootmagic.md). There is a lot of overlap between this functionality and the [Bootmagic Keycodes](feature_bootmagic.md#keycodes). Wherever possible we encourage you to use that feature instead of Command.
 
 On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`:
 

docs/feature_debounce_type.md

@@ -92,6 +92,15 @@ susceptible to noise, you must choose a debounce method that will also mitigate
 ## Debounce algorithms supported by QMK
 
 QMK supports multiple debounce algorithms through its debounce API.
+The logic for which debounce method called is below. It checks various defines that you have set in ```rules.mk```
+
+```
+DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
+DEBOUNCE_TYPE?= sym_defer_g
+ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
+    QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
+endif
+```
 
 ### Debounce selection
 
@@ -112,16 +121,16 @@ DEBOUNCE_TYPE = <name of algorithm>
 Where name of algorithm is one of:
 * ```sym_defer_g``` - debouncing per keyboard. On any state change, a global timer is set. When ```DEBOUNCE``` milliseconds of no changes has occurred, all input changes are pushed.
   * This is the current default algorithm. This is the highest performance algorithm with lowest memory usage, and it's also noise-resistant.
-* ```sym_eager_pr``` - debouncing per row. On any state change, response is immediate, followed by locking the row ```DEBOUNCE``` milliseconds of no further input for that row.
+* ```sym_eager_pr``` - debouncing per row. On any state change, response is immediate, followed by locking the row ```DEBOUNCE``` milliseconds of no further input for that row. 
 For use in keyboards where refreshing ```NUM_KEYS``` 8-bit counters is computationally expensive / low scan rate, and fingers usually only hit one row at a time. This could be
 appropriate for the ErgoDox models; the matrix is rotated 90°, and hence its "rows" are really columns, and each finger only hits a single "row" at a time in normal use.
 * ```sym_eager_pk``` - debouncing per key. On any state change, response is immediate, followed by ```DEBOUNCE``` milliseconds of no further input for that key
 * ```sym_defer_pk``` - debouncing per key. On any state change, a per-key timer is set. When ```DEBOUNCE``` milliseconds of no changes have occurred on that key, the key status change is pushed.
-* ```asym_eager_defer_pk``` - debouncing per key. On a key-down state change, response is immediate, followed by ```DEBOUNCE``` milliseconds of no further input for that key. On a key-up state change, a per-key timer is set. When ```DEBOUNCE``` milliseconds of no changes have occurred on that key, the key-up status change is pushed.
 
 ### A couple algorithms that could be implemented in the future:
 * ```sym_defer_pr```
 * ```sym_eager_g```
+* ```asym_eager_defer_pk```
 
 ### Use your own debouncing code
 You have the option to implement you own debouncing algorithm. To do this:
@@ -131,3 +140,11 @@ You have the option to implement you own debouncing algorithm. To do this:
 * Debouncing occurs after every raw matrix scan.
 * Use num_rows rather than MATRIX_ROWS, so that split keyboards are supported correctly.
 * If the algorithm might be applicable to other keyboards, please consider adding it to ```quantum/debounce```
+
+### Old names
+The following old names for existing algorithms will continue to be supported, however it is recommended to use the new names instead.
+
+* sym_g - old name for sym_defer_g
+* eager_pk - old name for sym_eager_pk
+* sym_pk - old name for sym_defer_pk
+* eager_pr - old name for sym_eager_pr

docs/feature_digitizer.md

@@ -1,35 +0,0 @@
-## Digitizer
-
-The digitizer HID interface allows setting the mouse cursor position at absolute coordinates, unlike the Pointing Device feature that applies relative displacements.
-
-To enable the digitizer interface, add the following line to your rules.mk: 
-
-```makefile
-DIGITIZER_ENABLE = yes
-```
-
-In order to change the mouse cursor position from your keymap.c file, include the digitizer header : 
-
-```c
-#include "digitizer.h"
-```
-
-This gives you access to the `digitizer` structure which members allow you to change the cursor position.
-
-The coordinates are normalized, meaning there value must be set between 0 and 1. For the `x` coordinate, the value `0` is the leftmost position, whereas the value `1` is the rightmost position.
-For the `y` coordinate, `0` is at the top and `1` at the bottom.
-
-Here is an example setting the cursor in the middle of the screen:
-
-```c
-digitizer_t digitizer;
-digitizer.x = 0.5;
-digitizer.y = 0.5;
-digitizer.tipswitch = 0;
-digitizer.inrange = 1;
-digitizer_set_report(digitizer);
-```
-
-The `tipswitch` member triggers what equates to a click when set to `1`. The `inrange` member is required for the change in coordinates to be taken. It can then be set to `0` in a new report to signal the end of the digitizer interaction, but it is not strictly required.
-
-Once all members are set to the desired value, the `status` member needs its bitmask `DZ_UPDATED` to be set so the report is sent during the next main loop iteration.

docs/feature_dip_switch.md

@@ -9,8 +9,6 @@ and this to your `config.h`:
 ```c
 // Connects each switch in the dip switch to the GPIO pin of the MCU
 #define DIP_SWITCH_PINS { B14, A15, A10, B9 }
-// For split keyboards, you can separately define the right side pins
-#define DIP_SWITCH_PINS_RIGHT { ... }
 ```
 
 or
@@ -25,9 +23,8 @@ or
 The callback functions can be inserted into your `<keyboard>.c`:
 
 ```c
-bool dip_switch_update_kb(uint8_t index, bool active) { 
-    if (!dip_switch_update_user(index, active)) { return false; }
-    return true;
+void dip_switch_update_kb(uint8_t index, bool active) { 
+    dip_switch_update_user(index, active); 
 }
 ```
 
@@ -35,7 +32,7 @@ bool dip_switch_update_kb(uint8_t index, bool active) {
 or `keymap.c`:
 
 ```c
-bool dip_switch_update_user(uint8_t index, bool active) { 
+void dip_switch_update_user(uint8_t index, bool active) { 
     switch (index) {
         case 0:
             if(active) { audio_on(); } else { audio_off(); }
@@ -60,7 +57,6 @@ bool dip_switch_update_user(uint8_t index, bool active) {
             }
             break;
     }
-    return true;
 }
 ```
 
@@ -68,9 +64,8 @@ Additionally, we support bit mask functions which allow for more complex handlin
 
 
 ```c
-bool dip_switch_update_mask_kb(uint32_t state) { 
-    if (!dip_switch_update_mask_user(state)) { return false; }
-    return true;
+void dip_switch_update_mask_kb(uint32_t state) { 
+    dip_switch_update_mask_user(state); 
 }
 ```
 
@@ -78,7 +73,7 @@ bool dip_switch_update_mask_kb(uint32_t state) {
 or `keymap.c`:
 
 ```c
-bool dip_switch_update_mask_user(uint32_t state) { 
+void dip_switch_update_mask_user(uint32_t state) { 
     if (state & (1UL<<0) && state & (1UL<<1)) {
         layer_on(_ADJUST); // C on esc
     } else {
@@ -94,10 +89,10 @@ bool dip_switch_update_mask_user(uint32_t state) {
     } else {
         layer_off(_TEST_B);
     }
-    return true;
 }
 ```
 
+
 ## Hardware
 
 ### Connects each switch in the dip switch to the GPIO pin of the MCU

docs/feature_encoders.md

@@ -38,12 +38,6 @@ It can also be defined per-encoder, by instead defining:
 #define ENCODER_RESOLUTIONS { 4, 2 }
 ```
 
-For 4× encoders you also can assign default position if encoder skips pulses when it changes direction. For example, if your encoder send high level on both pins by default, define this:
-
-```c
-#define ENCODER_DEFAULT_POS 0x3
-```
-
 ## Split Keyboards
 
 If you are using different pinouts for the encoders on each half of a split keyboard, you can define the pinout (and optionally, resolutions) for the right half like this:
@@ -59,15 +53,15 @@ If you are using different pinouts for the encoders on each half of a split keyb
 The callback functions can be inserted into your `<keyboard>.c`:
 
 ```c
-bool encoder_update_kb(uint8_t index, bool clockwise) {
-    return encoder_update_user(index, clockwise);
+void encoder_update_kb(uint8_t index, bool clockwise) {
+    encoder_update_user(index, clockwise);
 }
 ```
 
 or `keymap.c`:
 
 ```c
-bool encoder_update_user(uint8_t index, bool clockwise) {
+void encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) { /* First encoder */
         if (clockwise) {
             tap_code(KC_PGDN);
@@ -81,29 +75,9 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
             tap_code(KC_UP);
         }
     }
-    return true;
 }
 ```
 
-!> If you return `true`, this will allow the keyboard level code to run, as well.  Returning `false` will override the keyboard level code.  Depending on how the keyboard level function is set up. 
-
 ## Hardware
 
 The A an B lines of the encoders should be wired directly to the MCU, and the C/common lines should be wired to ground.
-
-## Multiple Encoders
-
-Multiple encoders may share pins so long as each encoder has a distinct pair of pins. 
-
-For example you can support two encoders using only 3 pins like this
-```
-#define ENCODERS_PAD_A { B1, B1 }
-#define ENCODERS_PAD_B { B2, B3 }
-```
-
-You could even support three encoders using only three pins (one per encoder) however in this configuration, rotating two encoders which share pins simultaneously will often generate incorrect output. For example:
-```
-#define ENCODERS_PAD_A { B1, B1, B2 }
-#define ENCODERS_PAD_B { B2, B3, B3 }
-```
-Here rotating Encoder 0 `B1 B2` and Encoder 1 `B1 B3` could be interpreted as rotating Encoder 2 `B2 B3` or `B3 B2` depending on the timing. This may still be a useful configuration depending on your use case 

docs/feature_haptic_feedback.md

@@ -39,7 +39,7 @@ Not all keycodes below will work depending on which haptic mechanism you have ch
 
 First you will need a build a circuit to drive the solenoid through a mosfet as most MCU will not be able to provide the current needed to drive the coil in the solenoid.
 
-[Wiring diagram provided by Adafruit](https://cdn-shop.adafruit.com/product-files/412/solenoid_driver.pdf)
+[Wiring diagram provided by Adafruit](https://playground.arduino.cc/uploads/Learning/solenoid_driver.pdf)
 
 
 | Settings                   | Default              | Description                                           |
@@ -162,28 +162,4 @@ This will set what sequence HPT_RST will set as the active mode. If not defined,
 
 ### DRV2605L Continuous Haptic Mode
 
-This mode sets continuous haptic feedback with the option to increase or decrease strength.
-
-## Haptic Key Exclusion
-The Haptic Exclusion is implemented as `__attribute__((weak)) bool get_haptic_enabled_key(uint16_t keycode, keyrecord_t *record)` in haptic.c. This allows a re-definition at the required level with the specific requirement / exclusion.
-
-### NO_HAPTIC_MOD
-With the entry of `#define NO_HAPTIC_MOD` in config.h, modifiers from Left Control to Right GUI will not trigger a feedback. This also includes modifiers in a Mod Tap configuration.
-
-### NO_HAPTIC_FN
-With the entry of `#define NO_HAPTIC_FN` in config.h, layer keys will not rigger a feedback.
-
-### NO_HAPTIC_ALPHA
-With the entry of `#define NO_HAPTIC_ALPHA` in config.h, none of the alpha keys (A ... Z) will trigger a feedback.
-
-### NO_HAPTIC_PUNCTUATION
-With the entry of `#define NO_HAPTIC_PUNCTUATION` in config.h, none of the following keys will trigger a feedback: Enter, ESC, Backspace, Space, Minus, Equal, Left Bracket, Right Bracket, Backslash, Non-US Hash, Semicolon, Quote, Grave, Comma, Slash, Dot, Non-US Backslash.
-
-### NO_HAPTIC_LOCKKEYS
-With the entry of `#define NO_HAPTIC_LOCKKEYS` in config.h, none of the following keys will trigger a feedback: Caps Lock, Scroll Lock, Num Lock.
-
-### NO_HAPTIC_NAV
-With the entry of `#define NO_HAPTIC_NAV` in config.h, none of the following keys will trigger a feedback: Print Screen, Pause, Insert, Delete, Page Down, Page Up, Left Arrow, Up Arrow, Right Arrow, Down Arrow, End, Home.
-
-### NO_HAPTIC_NUMERIC
-With the entry of `#define NO_HAPTIC_NUMERIC` in config.h, none of the following keys between 0 and 9 (KC_1 ... KC_0) will trigger a feedback.
+This mode sets continuous haptic feedback with the option to increase or decrease strength. 

docs/feature_key_overrides.md

@@ -1,229 +0,0 @@
-# Key Overrides
-
-Key overrides allow you to override modifier-key combinations to send a different modifier-key combination or perform completely custom actions. Don't want `shift` + `1` to type `!` on your computer? Use a key override to make your keyboard type something different when you press `shift` + `1`. The general behavior is like this: If `modifiers w` + `key x` are pressed, replace these keys with `modifiers y` + `key z` in the keyboard report.
-
-You can use key overrides in a similar way to momentary layer/fn keys to activate custom keycodes/shortcuts, with a number of benefits: You completely keep the original use of the modifier keys, while being able to save space by removing fn keys from your keyboard. You can also easily configure _combinations of modifiers_ to trigger different actions than individual modifiers, and much more. The possibilities are quite vast and this documentation contains a few examples for inspiration throughout.
-
-##### A few more examples to get started: You could use key overrides to...
-- Send `brightness up/down` when pressing `ctrl` + `volume up/down`.
-- Send `delete` when pressing `shift` + `backspace`.
-- Create custom shortcuts or change existing ones: E.g. Send `ctrl`+`shift`+`z` when `ctrl`+`y` is pressed.
-- Run custom code when `ctrl` + `alt` + `esc` is pressed.
-
-## Setup
-
-To enable this feature, you need to add `KEY_OVERRIDE_ENABLE = yes` to your `rules.mk`.
-
-Then, in your `keymap.c` file, you'll need to define the array `key_overrides`, which defines all key overrides to be used. Each override is a value of type `key_override_t`. The array `key_overrides` is `NULL`-terminated and contains pointers to `key_override_t` values (`const key_override_t **`).
-
-## Creating Key Overrides
-
-The `key_override_t` struct has many options that allow you to precisely tune your overrides. The full reference is shown below. Instead of manually creating a `key_override_t` value, it is recommended to use these dedicated initializers:
-
-#### `ko_make_basic(modifiers, key, replacement)`
-Returns a `key_override_t`, which sends `replacement` (can be a key-modifer combination), when `key` and `modifiers` are all pressed down. This override still activates if any additional modifiers not specified in `modifiers` are also pressed down. See `ko_make_with_layers_and_negmods` to customize this behavior.
-
-#### `ko_make_with_layers(modifiers, key, replacement, layers)`
-Additionally takes a bitmask `layers` that defines on which layers the override is used.
-
-#### `ko_make_with_layers_and_negmods(modifiers, key, replacement, layers, negative_mods)`
-Additionally takes a bitmask `negative_mods` that defines which modifiers may not be pressed for this override to activate.
-
-#### `ko_make_with_layers_negmods_and_options(modifiers, key, replacement, layers, negative_mods, options)`
-Additionally takes a bitmask `options` that specifies additional options. See `ko_option_t` for available options.
-
-For more customization possibilities, you may directly create a `key_override_t`, which allows you to customize even more behavior. Read further below for details and examples.
-
-## Simple Example
-
-This shows how the mentioned example of sending `delete` when `shift` + `backspace` are pressed is realized:
-
-```c
-const key_override_t delete_key_override = ko_make_basic(MOD_MASK_SHIFT, KC_BSPACE, KC_DELETE);
-
-// This globally defines all key overrides to be used
-const key_override_t **key_overrides = (const key_override_t *[]){
-	&delete_key_override,
-	NULL // Null terminate the array of overrides!
-};
-```
-
-## Intermediate Difficulty Examples
-
-### Media Controls & Screen Brightness
-
-In this example a single key is configured to control media, volume and screen brightness by using key overrides.
-
-- The key is set to send `play/pause` in the keymap.
-
-The following key overrides will be configured:
-
-- `Ctrl` + `play/pause` will send `next track`.
-- `Ctrl` + `Shift` + `play/pause` will send `previous track`. 
-- `Alt` + `play/pause` will send `volume up`. 
-- `Alt` + `Shift` + `play/pause` will send `volume down`.
-- `Ctrl` + `Alt` + `play/pause` will send `brightness up`.
-- `Ctrl` + `Alt` + `Shift` + `play/pause` will send `brightness down`.
-
-
-```c
-const key_override_t next_track_override = 
-	ko_make_with_layers_negmods_and_options(
-   		MOD_MASK_CTRL,       // Trigger modifiers: ctrl
-    	KC_MPLY,             // Trigger key: play/pause
-    	KC_MNXT,             // Replacement key
-    	~0,                  // Activate on all layers
-    	MOD_MASK_SA,         // Do not activate when shift or alt are pressed
-    	ko_option_no_reregister_trigger); // Specifies that the play key is not registered again after lifting ctrl
-    
-const key_override_t prev_track_override = ko_make_with_layers_negmods_and_options(MOD_MASK_CS, KC_MPLY,
-											KC_MPRV, ~0, MOD_MASK_ALT, ko_option_no_reregister_trigger);
-
-const key_override_t vol_up_override = ko_make_with_layers_negmods_and_options(MOD_MASK_ALT, KC_MPLY,
-											KC_VOLU, ~0, MOD_MASK_CS, ko_option_no_reregister_trigger);
-
-const key_override_t vol_down_override = ko_make_with_layers_negmods_and_options(MOD_MASK_SA, KC_MPLY,
-											KC_VOLD, ~0, MOD_MASK_CTRL, ko_option_no_reregister_trigger);
-
-const key_override_t brightness_up_override = ko_make_with_layers_negmods_and_options(MOD_MASK_CA, KC_MPLY,
-											KC_BRIU, ~0, MOD_MASK_SHIFT, ko_option_no_reregister_trigger);
-
-const key_override_t brightness_down_override = ko_make_basic(MOD_MASK_CSA, KC_MPLY, KC_BRID);
-
-// This globally defines all key overrides to be used
-const key_override_t **key_overrides = (const key_override_t *[]){
-	&next_track_override,
-	&prev_track_override,
-	&vol_up_override,
-	&vol_down_override,
-	&brightness_up_override,
-	&brightness_down_override,
-	NULL
-};
-```
-
-### Flexible macOS-friendly Grave Escape
-The [Grave Escape feature](feature_grave_esc.md) is limited in its configurability and has [bugs when used on macOS](feature_grave_esc.md#caveats). Key overrides can be used to achieve a similar functionality as Grave Escape, but with more customization and without bugs on macOS.
-
-```c
-// Shift + esc = ~
-const key_override_t tilde_esc_override = ko_make_basic(MOD_MASK_SHIFT, KC_ESC, S(KC_GRAVE));
-
-// GUI + esc = `
-const key_override_t grave_esc_override = ko_make_basic(MOD_MASK_GUI, KC_ESC, KC_GRAVE);
-
-const key_override_t **key_overrides = (const key_override_t *[]){
-	&tilde_esc_override,
-	&grave_esc_override,
-	NULL
-};
-```
-
-In addition to not encountering unexpected bugs on macOS, you can also change the behavior as you wish. Instead setting `GUI` + `ESC` = `` ` `` you may change it to an arbitrary other modifier, for example `Ctrl` + `ESC` = `` ` ``.
-
-## Advanced Examples
-### Modifiers as Layer Keys
-
-Do you really need a dedicated key to toggle your fn layer? With key overrides, perhaps not. This example shows how you can configure to use `rGUI` + `rAlt` (right GUI and right alt) to access a momentary layer like an fn layer. With this you completely eliminate the need to use a dedicated layer key. Of course the choice of modifier keys can be changed as needed, `rGUI` + `rAlt` is just an example here. 
-
-```c
-// This is called when the override activates and deactivates. Enable the fn layer on activation and disable on deactivation
-bool momentary_layer(bool key_down, void *layer) {
-    if (key_down) {
-        layer_on((uint8_t)(uintptr_t)layer);
-    } else {
-        layer_off((uint8_t)(uintptr_t)layer);
-    }
-
-    return false;
-}
-
-const key_override_t fn_override = {.trigger_mods          = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL),                       //
-                                   .layers                 = ~(1 << LAYER_FN),                                          //
-                                   .suppressed_mods        = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL),                       //
-                                   .options                = ko_option_no_unregister_on_other_key_down,                 //
-                                   .negative_mod_mask      = (uint8_t) ~(MOD_BIT(KC_RGUI) | MOD_BIT(KC_RCTL)),          //
-                                   .custom_action          = momentary_layer,                                           //
-                                   .context                = (void *)LAYER_FN,                                          //
-                                   .trigger                = KC_NO,                                                     //
-                                   .replacement            = KC_NO,                                                     //
-                                   .enabled                = NULL};
-```
-
-## Keycodes 
-
-You can enable, disable and toggle all key overrides on the fly.
-
-|Keycode   |Description                      |Function Equivalent|
-|----------|---------------------------------|--------|
-|`KEY_OVERRIDE_ON`  |Turns on Key Override feature           | `key_override_on(void)`|
-|`KEY_OVERRIDE_OFF` |Turns off Key Override feature          |`key_override_off(void)`|
-|`KEY_OVERRIDE_TOGGLE` |Toggles Key Override feature on and off |`key_override_toggle(void)`|
-
-## Reference for `key_override_t`
-
-Advanced users may need more customization than what is offered by the simple `ko_make` initializers. For this, directly create a `key_override_t` value and set all members. Below is a reference for all members of `key_override_t`.
-
-| Member                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-|--------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `uint16_t trigger`                                     | The non-modifier keycode that triggers the override. This keycode, and the necessary modifiers (`trigger_mods`) must be pressed to activate this override. Set this to the keycode of the key that should activate the override. Set to `KC_NO` to require only the necessary modifiers to be pressed and no non-modifier.                                                                                                                                                                                                                                                                                                                                |
-| `uint8_t trigger_mods`                            | Which mods need to be down for activation. If both sides of a modifier are set (e.g. left ctrl and right ctrl) then only one is required to be pressed (e.g. left ctrl suffices). Use the `MOD_MASK_XXX` and `MOD_BIT()` macros for this.                                                                                                                                                                                                                                                                            |
-| `layer_state_t layers`                                 | This is a BITMASK (!), defining which layers this override applies to. To use this override on layer i set the ith bit `(1 << i)`.                                                                                                                                                                                                                                                                                                                   |
-| `uint8_t negative_mod_mask`                       | Which modifiers cannot be down. It must hold that `(active_modifiers & negative_mod_mask) == 0`, otherwise the key override will not be activated. An active override will be deactivated once this is no longer true.                                                                                                                                                                                                                                                                                                     |
-| `uint8_t suppressed_mods`                              | Modifiers to 'suppress' while the override is active. To suppress a modifier means that even though the modifier key is held down, the host OS sees the modifier as not pressed. Can be used to suppress the trigger modifiers, as a trivial example.                                                                                                                                                                                                                                                                                                                                            |
-| `uint16_t replacement`                                 | The complex keycode to send as replacement when this override is triggered. This can be a simple keycode, a key-modifier combination (e.g. `C(KC_A)`), or `KC_NO` (to register no replacement keycode). Use in combination with suppressed_mods to get the correct modifiers to be sent.                                                                                                                                                                                                                 |
-| `ko_option_t options`             | Options controlling the behavior of the override, such as what actions are allowed to activate the override.                                                                                                                                                                                                                                                                                                                |
-| `bool (*custom_action)(bool activated, void *context)` | If not NULL, this function will be called right before the replacement key is registered, along with the provided context and a flag indicating whether the override was activated or deactivated. This function allows you to run some custom actions for specific key overrides. If you return `false`, the replacement key is not registered/unregistered as it would normally. Return `true` to register and unregister the override normally. |
-| `void *context`                                        | A context that will be passed to the custom action function.                                                                                                                                                                                                                                                                                                                                                                        |
-| `bool *enabled`                                        | If this points to false this override will not be used. Set to NULL to always have this override enabled.                                                                                                                                                                                                                                                                                                                                          |
-
-### Reference for `ko_option_t`
-
-Bitfield with various options controlling the behavior of a key override.
-
-| Value                                    | Description                                                                                                                                                                                                            |
-|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `ko_option_activation_trigger_down`      | Allow activating when the trigger key is pressed down.                                                                                                                                                                 |
-| `ko_option_activation_required_mod_down` | Allow activating when a necessary modifier is pressed down.                                                                                                                                                                                     |
-| `ko_option_activation_negative_mod_up`   | Allow activating when a negative modifier is released.                                                                                                                                                                 |
-| `ko_option_one_mod`                      | If set, any of the modifiers in `trigger_mods` will be enough to activate the override (logical OR of modifiers). If not set, all the modifiers in `trigger_mods` have to be pressed (logical AND of modifiers). |
-| `ko_option_no_unregister_on_other_key_down`    |  If set, the override will not deactivate when another key is pressed down. Use only if you really know you need this.                                                                                                                          |
-| `ko_option_no_reregister_trigger`        | If set, the trigger key will never be registered again after the override is deactivated.                                                                                                                              |
-| `ko_options_default`                     | The default options used by the `ko_make_xxx` functions                                                                                                                                                                  |
-
-## For Advanced Users: Inner Workings
-
-This section explains how a key override works in detail, explaining where each member of `key_override_t` comes into play. Understanding this is essential to be able to take full advantage of all the options offered by key overrides.
-
-#### Activation
-
-When the necessary keys are pressed (`trigger_mods` + `trigger`), the override is 'activated' and the replacement key is registered in the keyboard report (`replacement`), while the `trigger` key is removed from the keyboard report. The trigger modifiers may also be removed from the keyboard report upon activation of an override (`suppressed_mods`). The override will not activate if any of the `negative_modifiers` are pressed.
-
-Overrides can activate in three different cases:
-
-1. The trigger key is pressed down and necessary modifiers are already down.
-2. A necessary modifier is pressed down, while the trigger key and other necessary modifiers are already down.
-3. A negative modifier is released, while all necessary modifiers and the trigger key are already down.
-
-Use the `option` member to customize which of these events are allowed to activate your overrides (default: all three).
-
-In any case, a key override can only activate if the `trigger` key is the _last_ non-modifier key that was pressed down. This emulates the behavior of how standard OSes (macOS, Windows, Linux) handle normal key input (to understand: Hold down `a`, then also hold down `b`, then hold down `shift`; `B` will be typed but not `A`).
-
-#### Deactivation
-
-An override is 'deactivated' when one of the trigger keys (`trigger_mods`, `trigger`) is lifted, another non-modifier key is pressed down, or one of the `negative_modifiers` is pressed down. When an override deactivates, the `replacement` key is removed from the keyboard report, while the `suppressed_mods` that are still held down are re-added to the keyboard report. By default, the `trigger` key is re-added to the keyboard report if it is still held down and no other non-modifier key has been pressed since. This again emulates the behavior of how standard OSes handle normal key input (To understand: hold down `a`, then also hold down `b`, then also `shift`, then release `b`; `A` will not be typed even though you are holding the `a` and `shift` keys). Use the `option` field `ko_option_no_reregister_trigger` to prevent re-registering the trigger key in all cases.
-
-#### Key Repeat Delay
-
-A third way in which standard OS-handling of modifier-key input is emulated in key overrides is with a ['key repeat delay'](https://www.dummies.com/computers/pcs/set-your-keyboards-repeat-delay-and-repeat-rate/). To explain what this is, let's look at how normal keyboard input is handled by mainstream OSes again: If you hold down `a`, followed by `shift`, you will see the letter `a` is first typed, then for a short moment nothing is typed and then repeating `A`s are typed. Take note that, although shift is pressed down just after `a` is pressed, it takes a moment until `A` is typed. This is caused by the aforementioned key repeat delay, and it is a feature that prevents unwanted repeated characters from being typed.
-
-This applies equally to releasing a modifier: When you hold `shift`, then press `a`, the letter `A` is typed. Now if you release `shift` first, followed by `a` shortly after, you will not see the letter `a` being typed, even though for a short moment of time you were just holding down the key `a`. This is because no modified characters are typed until the key repeat delay has passed.
-
- This exact behavior is implemented in key overrides as well: If a key override for `shift` + `a` = `b` exists, and `a` is pressed and held, followed by `shift`, you will not immediately see the letter `b` being typed. Instead, this event is deferred for a short moment, until the key repeat delay has passed, measured from the moment when the trigger key (`a`) was pressed down.
-
-The duration of the key repeat delay is controlled with the `KEY_OVERRIDE_REPEAT_DELAY` macro. Define this value in your `config.h` file to change it. It is 500ms by default.
-
-
-## Difference to Combos
-
-Note that key overrides are very different from [combos](https://docs.qmk.fm/#/feature_combo). Combos require that you press down several keys almost _at the same time_ and can work with any combination of non-modifier keys. Key overrides work like keyboard shortcuts (e.g. `ctrl` + `z`): They take combinations of _multiple_ modifiers and _one_ non-modifier key to then perform some custom action. Key overrides are implemented with much care to behave just like normal keyboard shortcuts would in regards to the order of pressed keys, timing, and interacton with other pressed keys. There are a number of optional settings that can be used to really fine-tune the behavior of each key override as well. Using key overrides also does not delay key input for regular key presses, which inherently happens in combos and may be undesirable.

docs/feature_layers.md

@@ -19,10 +19,12 @@ These functions allow you to activate layers in various ways. Note that layers a
 
 ### Caveats :id=caveats
 
-Currently, the `layer` argument of `LT()` is limited to layers 0-15, and the `kc` argument to the [Basic Keycode set](keycodes_basic.md), meaning you can't use keycodes like `LCTL()`, `KC_TILD`, or anything greater than `0xFF`. This is because QMK uses 16-bit keycodes, of which 4 bits are used for the function identifier and 4 bits for the layer, leaving only 8 bits for the keycode.
+Currently, `LT()` and `MT()` are limited to the [Basic Keycode set](keycodes_basic.md), meaning you can't use keycodes like `LCTL()`, `KC_TILD`, or anything greater than `0xFF`. Specifically, dual function keys like `LT` and `MT` use a 16 bit keycode. 4 bits are used for the function identifier, the next 12 are divided into the parameters. Layer Tap uses 4 bits for the layer (and is why it's limited to layers 0-15, actually), while Mod Tap does the same, 4 bits for the identifier, 4 bits for which mods are used, and all of them use 8 bits for the keycode. Because of this, the keycode used is limited to `0xFF` (0-255), which are the basic keycodes only. 
 
 Expanding this would be complicated, at best. Moving to a 32-bit keycode would solve a lot of this, but would double the amount of space that the keymap matrix uses. And it could potentially cause issues, too. If you need to apply modifiers to your tapped keycode, [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) can be used to accomplish this.
 
+Additionally, if at least one right-handed modifier is specified in a Mod Tap or Layer Tap, it will cause all modifiers specified to become right-handed, so it is not possible to mix and match the two.
+
 ## Working with Layers :id=working-with-layers
 
 Care must be taken when switching layers, it's possible to lock yourself into a layer with no way to deactivate that layer (without unplugging your keyboard.) We've created some guidelines to help users avoid the most common problems.

docs/feature_leader_key.md

@@ -72,19 +72,6 @@ SEQ_THREE_KEYS(KC_C, KC_C, KC_C) {
 }
 ```
 
-## Infinite Leader key timeout
-
-Sometimes your leader key is not on a comfortable places as the rest of keys on your sequence. Imagine that your leader key is one of your outer top right keys, you may need to reposition your hand just to reach your leader key.
-This can make typing the entire sequence on time hard even if you are able to type most of the sequence fast. For example, if your sequence is `Leader + asd` typing `asd` fast is very easy once you have your hands in your home row. However starting the sequence in time after moving your hand out of the home row to reach the leader key and back is not.
-To remove the stress this situation produces to your hands you can enable an infinite timeout just for the leader key. This mean that, after you hit the leader key you will have an infinite amount of time to start the rest of the sequence, allowing you to proper position your hands on the best position to type the rest of the sequence comfortably.
-This infinite timeout only affects the leader key, so in our previous example of `Leader + asd` you will have an infinite amount of time between `Leader` and `a`, but once you start the sequence the timeout you have configured (global or per key) will work normally.
-This way you can configure a very short `LEADER_TIMEOUT` but still have plenty of time to position your hands.
-
-In order to enable this, place this in your `config.h`:
-```c
-#define LEADER_NO_TIMEOUT
-```
-
 ## Strict Key Processing
 
 By default, the Leader Key feature will filter the keycode out of [`Mod-Tap`](mod_tap.md) and [`Layer Tap`](feature_layers.md#switching-and-toggling-layers) functions when checking for the Leader sequences. That means if you're using `LT(3, KC_A)`, it will pick this up as `KC_A` for the sequence, rather than `LT(3, KC_A)`, giving a more expected behavior for newer users.
@@ -105,7 +92,7 @@ void leader_start(void) {
 }
 
 void leader_end(void) {
-  // sequence ended (no success/failure detection)
+  // sequence ended (no success/failuer detection)
 }
 ```
 

docs/feature_led_indicators.md

@@ -1,7 +1,5 @@
 # LED Indicators
 
-?>  Currently, this feature is not supported for split keyboards
-
 QMK provides methods to read 5 of the LEDs defined in the HID spec:
 
 * Num Lock

docs/feature_led_matrix.md

@@ -1,28 +1,26 @@
-# LED Matrix Lighting :id=led-matrix-lighting
+# LED Matrix Lighting
 
 This feature allows you to use LED matrices driven by external drivers. It hooks into the backlight system so you can use the same keycodes as backlighting to control it.
 
 If you want to use RGB LED's you should use the [RGB Matrix Subsystem](feature_rgb_matrix.md) instead.
 
-## Driver configuration :id=driver-configuration
----
-### IS31FL3731 :id=is31fl3731
+## Driver configuration
 
-There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 LED controller. To enable it, add this to your `rules.mk`:
+### IS31FL3731
 
-```make
-LED_MATRIX_ENABLE = yes
-LED_MATRIX_DRIVER = IS31FL3731
-```
+There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
 
+    LED_MATRIX_ENABLE = yes
+    LED_MATRIX_DRIVER = IS31FL3731
+    
 You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
 
 | Variable | Description | Default |
 |----------|-------------|---------|
-| `ISSI_TIMEOUT` | (Optional) How long to wait for i2c messages, in milliseconds | 100 |
+| `ISSI_TIMEOUT` | (Optional) How long to wait for i2c messages | 100 |
 | `ISSI_PERSISTENCE` | (Optional) Retry failed messages this many times | 0 |
 | `LED_DRIVER_COUNT` | (Required) How many LED driver IC's are present | |
-| `DRIVER_LED_TOTAL` | (Required) How many LED lights are present across all drivers | |
+| `LED_DRIVER_LED_COUNT` | (Required) How many LED lights are present across all drivers | |
 | `LED_DRIVER_ADDR_1` | (Required) Address for the first LED driver | |
 | `LED_DRIVER_ADDR_2` | (Optional) Address for the second LED driver | |
 | `LED_DRIVER_ADDR_3` | (Optional) Address for the third LED driver | |
@@ -30,323 +28,64 @@ You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>
 
 Here is an example using 2 drivers.
 
-```c
-// This is a 7-bit address, that gets left-shifted and bit 0
-// set to 0 for write, 1 for read (as per I2C protocol)
-// The address will vary depending on your wiring:
-// 0b1110100 AD <-> GND
-// 0b1110111 AD <-> VCC
-// 0b1110101 AD <-> SCL
-// 0b1110110 AD <-> SDA
-#define LED_DRIVER_ADDR_1 0b1110100
-#define LED_DRIVER_ADDR_2 0b1110110
+	// This is a 7-bit address, that gets left-shifted and bit 0
+	// set to 0 for write, 1 for read (as per I2C protocol)
+	// The address will vary depending on your wiring:
+	// 0b1110100 AD <-> GND
+	// 0b1110111 AD <-> VCC
+	// 0b1110101 AD <-> SCL
+	// 0b1110110 AD <-> SDA
+	#define LED_DRIVER_ADDR_1 0b1110100
+	#define LED_DRIVER_ADDR_2 0b1110110
 
-#define LED_DRIVER_COUNT 2
-#define LED_DRIVER_1_LED_TOTAL 25
-#define LED_DRIVER_2_LED_TOTAL 24
-#define DRIVER_LED_TOTAL (LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL)
-```
+	#define LED_DRIVER_COUNT 2
+	#define LED_DRIVER_1_LED_COUNT 25
+	#define LED_DRIVER_2_LED_COUNT 24
+	#define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL
 
-!> Note the parentheses, this is so when `LED_DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL)` will give very different results than `rand() % LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL`.
+Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
 
 Define these arrays listing all the LEDs in your `<keyboard>.c`:
 
-```c
-const is31_led __flash g_is31_leds[DRIVER_LED_TOTAL] = {
-/* Refer to IS31 manual for these locations
- *    driver
- *    |  LED address
- *    |  | */
-    { 0, C1_1  },
-    { 0, C1_15 },
-    // ...
-}
-```
+	const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
+	/* Refer to IS31 manual for these locations
+	 *   driver
+	 *   |  LED address
+	 *   |  | */
+	    {0, C3_3},
+	    ....
+	}
 
-Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/led/issi/is31fl3731-simple.h`. The `driver` is the index of the driver you defined in your `config.h` (`0`, `1`, `2`, or `3` ).
+Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/issi/is31fl3731-simple.h`. The `driver` is the index of the driver you defined in your `config.h` (`0`, `1`, `2`, or `3` ).
 
----
+## Keycodes
 
-## Common Configuration :id=common-configuration
+All LED matrix keycodes are currently shared with the [backlight system](feature_backlight.md).
 
-From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:
+## LED Matrix Effects
 
-```c
-led_config_t g_led_config = { {
-  // Key Matrix to LED Index
-  {   5, NO_LED, NO_LED,   0 },
-  { NO_LED, NO_LED, NO_LED, NO_LED },
-  {   4, NO_LED, NO_LED,   1 },
-  {   3, NO_LED, NO_LED,   2 }
-}, {
-  // LED Index to Physical Position
-  { 188,  16 }, { 187,  48 }, { 149,  64 }, { 112,  64 }, {  37,  48 }, {  38,  16 }
-}, {
-  // LED Index to Flag
-  1, 4, 4, 4, 4, 1
-} };
-```
+Currently no LED matrix effects have been created.
 
-The first part, `// Key Matrix to LED Index`, tells the system what key this LED represents by using the key's electrical matrix row & col. The second part, `// LED Index to Physical Position` represents the LED's physical `{ x, y }` position on the keyboard. The default expected range of values for `{ x, y }` is the inclusive range `{ 0..224, 0..64 }`. This default expected range is due to effects that calculate the center of the keyboard for their animations. The easiest way to calculate these positions is imagine your keyboard is a grid, and the top left of the keyboard represents `{ x, y }` coordinate `{ 0, 0 }` and the bottom right of your keyboard represents `{ 224, 64 }`. Using this as a basis, you can use the following formula to calculate the physical position:
+## Custom layer effects
 
-```c
-x = 224 / (NUMBER_OF_COLS - 1) * COL_POSITION
-y =  64 / (NUMBER_OF_ROWS - 1) * ROW_POSITION
-```
+Custom layer effects can be done by defining this in your `<keyboard>.c`:
 
-Where NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout. 
+    void led_matrix_indicators_kb(void) {
+        led_matrix_set_index_value(index, value);
+    }
 
-As mentioned earlier, the center of the keyboard by default is expected to be `{ 112, 32 }`, but this can be changed if you want to more accurately calculate the LED's physical `{ x, y }` positions. Keyboard designers can implement `#define LED_MATRIX_CENTER { 112, 32 }` in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the `{ x, y }` values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.
+A similar function works in the keymap as `led_matrix_indicators_user`.
 
-`// LED Index to Flag` is a bitmask, whether or not a certain LEDs is of a certain type. It is recommended that LEDs are set to only 1 type.
+## Suspended state
 
-## Flags :id=flags
+To use the suspend feature, add this to your `<keyboard>.c`:
 
-|Define                      |Value |Description                                      |
-|----------------------------|------|-------------------------------------------------|
-|`HAS_FLAGS(bits, flags)`    |*n/a* |Evaluates to `true` if `bits` has all `flags` set|
-|`HAS_ANY_FLAGS(bits, flags)`|*n/a* |Evaluates to `true` if `bits` has any `flags` set|
-|`LED_FLAG_NONE`             |`0x00`|If this LED has no flags                         |
-|`LED_FLAG_ALL`              |`0xFF`|If this LED has all flags                        |
-|`LED_FLAG_MODIFIER`         |`0x01`|If the LED is on a modifier key                  |
-|`LED_FLAG_KEYLIGHT`         |`0x04`|If the LED is for key backlight                  |
-|`LED_FLAG_INDICATOR`        |`0x08`|If the LED is for keyboard state indication      |
+	void suspend_power_down_kb(void)
+	{
+	    led_matrix_set_suspend_state(true);
+	}
 
-## Keycodes :id=keycodes
-
-All LED matrix keycodes are currently shared with the [Backlight feature](feature_backlight.md).
-
-|Key      |Description                  |
-|---------|-----------------------------|
-|`BL_TOGG`|Toggle LED Matrix on or off  |
-|`BL_STEP`|Cycle through modes          |
-|`BL_ON`  |Turn on LED Matrix           |
-|`BL_OFF` |Turn off LED Matrix          |
-|`BL_INC` |Increase the brightness level|
-|`BL_DEC` |Decrease the brightness level|
-
-## LED Matrix Effects :id=led-matrix-effects
-
-These are the effects that are currently available:
-
-```c
-enum led_matrix_effects {
-    LED_MATRIX_NONE = 0,
-    LED_MATRIX_SOLID = 1,           // Static single val, no speed support
-    LED_MATRIX_ALPHAS_MODS,         // Static dual val, speed is val for LEDs marked as modifiers
-    LED_MATRIX_BREATHING,           // Cycling brightness animation
-    LED_MATRIX_BAND,                // Band fading brightness scrolling left to right
-    LED_MATRIX_BAND_PINWHEEL,       // 3 blade spinning pinwheel fades brightness
-    LED_MATRIX_BAND_SPIRAL,         // Spinning spiral fades brightness
-    LED_MATRIX_CYCLE_LEFT_RIGHT,    // Full gradient scrolling left to right
-    LED_MATRIX_CYCLE_UP_DOWN,       // Full gradient scrolling top to bottom
-    LED_MATRIX_CYCLE_OUT_IN,        // Full gradient scrolling out to in
-    LED_MATRIX_DUAL_BEACON,         // Full gradient spinning around center of keyboard
-#if defined(LED_MATRIX_KEYPRESSES) || defined(LED_MATRIX_KEYRELEASES)
-    LED_MATRIX_SOLID_REACTIVE_SIMPLE,   // Pulses keys hit then fades out
-    LED_MATRIX_SOLID_REACTIVE_WIDE       // Value pulses near a single key hit then fades out
-    LED_MATRIX_SOLID_REACTIVE_MULTIWIDE  // Value pulses near multiple key hits then fades out
-    LED_MATRIX_SOLID_REACTIVE_CROSS      // Value pulses the same column and row of a single key hit then fades out
-    LED_MATRIX_SOLID_REACTIVE_MULTICROSS // Value pulses the same column and row of multiple key hits then fades out
-    LED_MATRIX_SOLID_REACTIVE_NEXUS      // Value pulses away on the same column and row of a single key hit then fades out
-    LED_MATRIX_SOLID_REACTIVE_MULTINEXUS // Value pulses away on the same column and row of multiple key hits then fades out
-    LED_MATRIX_SOLID_SPLASH,             // Value pulses away from a single key hit then fades out
-    LED_MATRIX_SOLID_MULTISPLASH,        // Value pulses away from multiple key hits then fades out
-#endif
-    LED_MATRIX_WAVE_LEFT_RIGHT           // Sine wave scrolling from left to right
-    LED_MATRIX_WAVE_UP_DOWN              // Sine wave scrolling from up to down
-    LED_MATRIX_EFFECT_MAX
-};
-```
-
-You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `config.h`:
-
-
-|Define                                                 |Description                                    |
-|-------------------------------------------------------|-----------------------------------------------|
-|`#define ENABLE_LED_MATRIX_ALPHAS_MODS`                |Enables `LED_MATRIX_ALPHAS_MODS`              |
-|`#define ENABLE_LED_MATRIX_BREATHING`                  |Enables `LED_MATRIX_BREATHING`                |
-|`#define ENABLE_LED_MATRIX_BAND`                       |Enables `LED_MATRIX_BAND`                     |
-|`#define ENABLE_LED_MATRIX_BAND_PINWHEEL`              |Enables `LED_MATRIX_BAND_PINWHEEL`            |
-|`#define ENABLE_LED_MATRIX_BAND_SPIRAL`                |Enables `LED_MATRIX_BAND_SPIRAL`              |
-|`#define ENABLE_LED_MATRIX_CYCLE_LEFT_RIGHT`           |Enables `LED_MATRIX_CYCLE_LEFT_RIGHT`         |
-|`#define ENABLE_LED_MATRIX_CYCLE_UP_DOWN`              |Enables `LED_MATRIX_CYCLE_UP_DOWN`            |
-|`#define ENABLE_LED_MATRIX_CYCLE_OUT_IN`               |Enables `LED_MATRIX_CYCLE_OUT_IN`             |
-|`#define ENABLE_LED_MATRIX_DUAL_BEACON`                |Enables `LED_MATRIX_DUAL_BEACON`              |
-|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_SIMPLE`      |Enables `LED_MATRIX_SOLID_REACTIVE_SIMPLE`    |
-|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_WIDE`        |Enables `LED_MATRIX_SOLID_REACTIVE_WIDE`      |
-|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTIWIDE`   |Enables `LED_MATRIX_SOLID_REACTIVE_MULTIWIDE` |
-|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_CROSS`       |Enables `LED_MATRIX_SOLID_REACTIVE_CROSS`     |
-|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTICROSS`  |Enables `LED_MATRIX_SOLID_REACTIVE_MULTICROSS`|
-|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_NEXUS`       |Enables `LED_MATRIX_SOLID_REACTIVE_NEXUS`     |
-|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTINEXUS`  |Enables `LED_MATRIX_SOLID_REACTIVE_MULTINEXUS`|
-|`#define ENABLE_LED_MATRIX_SOLID_SPLASH`               |Enables `LED_MATRIX_SOLID_SPLASH`             |
-|`#define ENABLE_LED_MATRIX_SOLID_MULTISPLASH`          |Enables `LED_MATRIX_SOLID_MULTISPLASH`        |
-|`#define ENABLE_LED_MATRIX_WAVE_LEFT_RIGHT`            |Enables `LED_MATRIX_WAVE_LEFT_RIGHT`          |
-|`#define ENABLE_LED_MATRIX_WAVE_UP_DOWN`               |Enables `LED_MATRIX_WAVE_UP_DOWN`             |
-
-## Custom LED Matrix Effects :id=custom-led-matrix-effects
-
-By setting `LED_MATRIX_CUSTOM_USER` (and/or `LED_MATRIX_CUSTOM_KB`) in `rules.mk`, new effects can be defined directly from userspace, without having to edit any QMK core files.
-
-To declare new effects, create a new `led_matrix_user/kb.inc` that looks something like this:
-
-`led_matrix_user.inc` should go in the root of the keymap directory.
-`led_matrix_kb.inc` should go in the root of the keyboard directory.
-
-To use custom effects in your code, simply prepend `LED_MATRIX_CUSTOM_` to the effect name specified in `LED_MATRIX_EFFECT()`. For example, an effect declared as `LED_MATRIX_EFFECT(my_cool_effect)` would be referenced with:
-
-```c
-led_matrix_mode(led_MATRIX_CUSTOM_my_cool_effect);
-```
-
-```c
-// !!! DO NOT ADD #pragma once !!! //
-
-// Step 1.
-// Declare custom effects using the LED_MATRIX_EFFECT macro
-// (note the lack of semicolon after the macro!)
-LED_MATRIX_EFFECT(my_cool_effect)
-LED_MATRIX_EFFECT(my_cool_effect2)
-
-// Step 2.
-// Define effects inside the `LED_MATRIX_CUSTOM_EFFECT_IMPLS` ifdef block
-#ifdef LED_MATRIX_CUSTOM_EFFECT_IMPLS
-
-// e.g: A simple effect, self-contained within a single method
-static bool my_cool_effect(effect_params_t* params) {
-  LED_MATRIX_USE_LIMITS(led_min, led_max);
-  for (uint8_t i = led_min; i < led_max; i++) {
-    led_matrix_set_value(i, 0xFF);
-  }
-  return led_max < DRIVER_LED_TOTAL;
-}
-
-// e.g: A more complex effect, relying on external methods and state, with
-// dedicated init and run methods
-static uint8_t some_global_state;
-static void my_cool_effect2_complex_init(effect_params_t* params) {
-  some_global_state = 1;
-}
-static bool my_cool_effect2_complex_run(effect_params_t* params) {
-  LED_MATRIX_USE_LIMITS(led_min, led_max);
-  for (uint8_t i = led_min; i < led_max; i++) {
-    led_matrix_set_value(i, some_global_state++);
-  }
-
-  return led_max < DRIVER_LED_TOTAL;
-}
-static bool my_cool_effect2(effect_params_t* params) {
-  if (params->init) my_cool_effect2_complex_init(params);
-  return my_cool_effect2_complex_run(params);
-}
-
-#endif // LED_MATRIX_CUSTOM_EFFECT_IMPLS
-```
-
-For inspiration and examples, check out the built-in effects under `quantum/led_matrix_animations/`
-
-
-
-
-
-
-
-
-
-## Additional `config.h` Options :id=additional-configh-options
-
-```c
-#define LED_MATRIX_KEYPRESSES // reacts to keypresses
-#define LED_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
-#define LED_MATRIX_FRAMEBUFFER_EFFECTS // enable framebuffer effects
-#define LED_DISABLE_TIMEOUT 0 // number of milliseconds to wait until led automatically turns off
-#define LED_DISABLE_AFTER_TIMEOUT 0 // OBSOLETE: number of ticks to wait until disabling effects
-#define LED_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
-#define LED_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
-#define LED_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
-#define LED_MATRIX_MAXIMUM_BRIGHTNESS 255 // limits maximum brightness of LEDs
-#define LED_MATRIX_STARTUP_MODE LED_MATRIX_SOLID // Sets the default mode, if none has been set
-#define LED_MATRIX_STARTUP_VAL LED_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
-#define LED_MATRIX_STARTUP_SPD 127 // Sets the default animation speed, if none has been set
-#define LED_MATRIX_SPLIT { X, Y }   // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
-                                    // If LED_MATRIX_KEYPRESSES or LED_MATRIX_KEYRELEASES is enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
-```
-
-## EEPROM storage :id=eeprom-storage
-
-The EEPROM for it is currently shared with the RGB Matrix system (it's generally assumed only one feature would be used at a time), but could be configured to use its own 32bit address with:
-
-```c
-#define EECONFIG_LED_MATRIX (uint32_t *)28
-```
-
-Where `28` is an unused index from `eeconfig.h`.
-
-### Direct Operation :id=direct-operation
-|Function                                    |Description  |
-|--------------------------------------------|-------------|
-|`led_matrix_set_value_all(v)`         |Set all of the LEDs to the given value, where `v` is between 0 and 255 (not written to EEPROM) |
-|`led_matrix_set_value(index, v)`      |Set a single LED to the given value, where `v` is between 0 and 255, and `index` is between 0 and `DRIVER_LED_TOTAL` (not written to EEPROM) |
-
-### Disable/Enable Effects :id=disable-enable-effects
-|Function                                    |Description  |
-|--------------------------------------------|-------------|
-|`led_matrix_toggle()`                       |Toggle effect range LEDs between on and off |
-|`led_matrix_toggle_noeeprom()`              |Toggle effect range LEDs between on and off (not written to EEPROM) |
-|`led_matrix_enable()`                       |Turn effect range LEDs on, based on their previous state |
-|`led_matrix_enable_noeeprom()`              |Turn effect range LEDs on, based on their previous state (not written to EEPROM) |
-|`led_matrix_disable()`                      |Turn effect range LEDs off, based on their previous state |
-|`led_matrix_disable_noeeprom()`             |Turn effect range LEDs off, based on their previous state (not written to EEPROM) |
-
-### Change Effect Mode :id=change-effect-mode
-|Function                                    |Description  |
-|--------------------------------------------|-------------|
-|`led_matrix_mode(mode)`                     |Set the mode, if LED animations are enabled |
-|`led_matrix_mode_noeeprom(mode)`            |Set the mode, if LED animations are enabled (not written to EEPROM) |
-|`led_matrix_step()`                         |Change the mode to the next LED animation in the list of enabled LED animations |
-|`led_matrix_step_noeeprom()`                |Change the mode to the next LED animation in the list of enabled LED animations (not written to EEPROM) |
-|`led_matrix_step_reverse()`                 |Change the mode to the previous LED animation in the list of enabled LED animations |
-|`led_matrix_step_reverse_noeeprom()`        |Change the mode to the previous LED animation in the list of enabled LED animations (not written to EEPROM) |
-|`led_matrix_increase_speed()`               |Increase the speed of the animations |
-|`led_matrix_increase_speed_noeeprom()`      |Increase the speed of the animations (not written to EEPROM) |
-|`led_matrix_decrease_speed()`               |Decrease the speed of the animations |
-|`led_matrix_decrease_speed_noeeprom()`      |Decrease the speed of the animations (not written to EEPROM) |
-|`led_matrix_set_speed(speed)`               |Set the speed of the animations to the given value where `speed` is between 0 and 255 |
-|`led_matrix_set_speed_noeeprom(speed)`      |Set the speed of the animations to the given value where `speed` is between 0 and 255 (not written to EEPROM) |
-
-### Change Value :id=change-value
-|Function                                    |Description  |
-|--------------------------------------------|-------------|
-|`led_matrix_increase_val()`                 |Increase the value for effect range LEDs. This wraps around at maximum value |
-|`led_matrix_increase_val_noeeprom()`        |Increase the value for effect range LEDs. This wraps around at maximum value (not written to EEPROM) |
-|`led_matrix_decrease_val()`                 |Decrease the value for effect range LEDs. This wraps around at minimum value |
-|`led_matrix_decrease_val_noeeprom()`        |Decrease the value for effect range LEDs. This wraps around at minimum value (not written to EEPROM) |
-
-### Query Current Status :id=query-current-status
-|Function                         |Description                |
-|---------------------------------|---------------------------|
-|`led_matrix_is_enabled()`        |Gets current on/off status |
-|`led_matrix_get_mode()`          |Gets current mode          |
-|`led_matrix_get_val()`           |Gets current val           |
-|`led_matrix_get_speed()`         |Gets current speed         |
-|`led_matrix_get_suspend_state()` |Gets current suspend state |
-
-## Callbacks :id=callbacks
-
-### Indicators :id=indicators
-
-If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, you can use the `led_matrix_indicators_kb` or `led_matrix_indicators_user` function for that: 
-```c
-void led_matrix_indicators_kb(void) {
-    led_matrix_set_color(index, value);
-}
-```
-
-In addition, there are the advanced indicator functions.  These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive.  This includes a special macro to help make this easier to use: `LED_MATRIX_INDICATOR_SET_VALUE(i, v)`.
-
-```c
-void led_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
-    LED_MATRIX_INDICATOR_SET_VALUE(index, value);
-}
-```
+	void suspend_wakeup_init_kb(void)
+	{
+	    led_matrix_set_suspend_state(false);
+	}

docs/feature_macros.md

@@ -4,7 +4,7 @@ Macros allow you to send multiple keystrokes when pressing just one key. QMK has
 
 !> **Security Note**: While it is possible to use macros to send passwords, credit card numbers, and other sensitive information it is a supremely bad idea to do so. Anyone who gets a hold of your keyboard will be able to access that information by opening a text editor.
 
-## `SEND_STRING()` & `process_record_user`
+## The New Way: `SEND_STRING()` & `process_record_user`
 
 Sometimes you want a key to type out words or phrases. For the most common situations, we've provided `SEND_STRING()`, which will type out a string (i.e. a sequence of characters) for you. All ASCII characters that are easily translatable to a keycode are supported (e.g. `qmk 123\n\t`).
 
@@ -209,7 +209,7 @@ SEND_STRING(".."SS_TAP(X_END));
 
 There are some functions you may find useful in macro-writing. Keep in mind that while you can write some fairly advanced code within a macro, if your functionality gets too complex you may want to define a custom keycode instead. Macros are meant to be simple.
 
-?> You can also use the functions described in [Useful function](ref_functions.md) and [Checking modifier state](feature_advanced_keycodes#checking-modifier-state) for additional functionality. For example, `reset_keyboard()` allows you to reset the keyboard as part of a macro and `get_mods() & MOD_MASK_SHIFT` lets you check for the existence of active shift modifiers.
+?> You can also use the functions described in [Useful functions](ref_functions.md) for additional functionality. For example `reset_keyboard()` allows you to reset the keyboard as part of a macro.
 
 ### `record->event.pressed`
 
@@ -233,15 +233,9 @@ Parallel to `register_code` function, this sends the `<kc>` keyup event to the c
 
 ### `tap_code(<kc>);`
 
-Sends `register_code(<kc>)` and then `unregister_code(<kc>)`. This is useful if you want to send both the press and release events ("tap" the key, rather than hold it).
+This will send `register_code(<kc>)` and then `unregister_code(<kc>)`. This is useful if you want to send both the press and release events ("tap" the key, rather than hold it).
 
-If `TAP_CODE_DELAY` is defined (default 0), this function waits that many milliseconds before calling `unregister_code(<kc>)`. This can be useful when you are having issues with taps (un)registering.
-
-If the keycode is `KC_CAPS`, it waits `TAP_HOLD_CAPS_DELAY` milliseconds instead (default 80), as macOS prevents accidental Caps Lock activation by waiting for the key to be held for a certain amount of time.
-
-### `tap_code_delay(<kc>, <delay>);`
-
-Like `tap_code(<kc>)`, but with a `delay` parameter for specifying arbitrary intervals before sending the unregister event.
+If you're having issues with taps (un)registering, you can add a delay between the register and unregister events by setting `#define TAP_CODE_DELAY 100` in your `config.h` file. The value is in milliseconds.
 
 ### `register_code16(<kc>);`, `unregister_code16(<kc>);` and `tap_code16(<kc>);`
 
@@ -268,15 +262,15 @@ This will clear all keys besides the mods currently pressed.
 This macro will register `KC_LALT` and tap `KC_TAB`, then wait for 1000ms. If the key is tapped again, it will send another `KC_TAB`; if there is no tap, `KC_LALT` will be unregistered, thus allowing you to cycle through windows.
 
 ```c
-bool is_alt_tab_active = false; // ADD this near the begining of keymap.c
-uint16_t alt_tab_timer = 0;     // we will be using them soon.
+bool is_alt_tab_active = false;    # ADD this near the begining of keymap.c
+uint16_t alt_tab_timer = 0;        # we will be using them soon.
 
-enum custom_keycodes {          // Make sure have the awesome keycode ready
+enum custom_keycodes {             # Make sure have the awesome keycode ready
   ALT_TAB = SAFE_RANGE,
 };
 
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  switch (keycode) { // This will do most of the grunt work with the keycodes.
+  switch (keycode) {               # This will do most of the grunt work with the keycodes.
     case ALT_TAB:
       if (record->event.pressed) {
         if (!is_alt_tab_active) {
@@ -293,7 +287,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
   return true;
 }
 
-void matrix_scan_user(void) { // The very important timer.
+void matrix_scan_user(void) {     # The very important timer.
   if (is_alt_tab_active) {
     if (timer_elapsed(alt_tab_timer) > 1000) {
       unregister_code(KC_LALT);
@@ -302,3 +296,104 @@ void matrix_scan_user(void) { // The very important timer.
   }
 }
 ```
+
+---
+
+##  **(DEPRECATED)** The Old Way: `MACRO()` & `action_get_macro`
+
+!> This is inherited from TMK, and hasn't been updated - it's recommended that you use `SEND_STRING` and `process_record_user` instead.
+
+By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:
+
+```c
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    if (record->event.pressed) {
+        switch(id) {
+            case 0:
+                return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
+            case 1:
+                return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
+        }
+    }
+    return MACRO_NONE;
+};
+```
+
+This defines two macros which will be run when the key they are assigned to is pressed. If instead you'd like them to run when the key is released you can change the if statement:
+
+    if (!record->event.pressed) {
+
+### Macro Commands
+
+A macro can include the following commands:
+
+* I() change interval of stroke in milliseconds.
+* D() press key.
+* U() release key.
+* T() type key(press and release).
+* W() wait (milliseconds).
+* END end mark.
+
+### Mapping a Macro to a Key
+
+Use the `M()` function within your keymap to call a macro. For example, here is the keymap for a 2-key keyboard:
+
+```c
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        M(0), M(1)
+    ),
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    if (record->event.pressed) {
+        switch(id) {
+            case 0:
+                return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
+            case 1:
+                return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
+        }
+    }
+    return MACRO_NONE;
+};
+```
+
+When you press the key on the left it will type "Hi!" and when you press the key on the right it will type "Bye!".
+
+### Naming Your Macros
+
+If you have a bunch of macros you want to refer to from your keymap while keeping the keymap easily readable you can name them using `#define` at the top of your file.
+
+```c
+#define M_HI M(0)
+#define M_BYE M(1)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        M_HI, M_BYE
+    ),
+};
+```
+
+
+## Advanced Example:
+
+### Single-Key Copy/Paste
+
+This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
+
+```c
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch(id) {
+        case 0: {
+            if (record->event.pressed) {
+                return MACRO( D(LCTL), T(C), U(LCTL), END  );
+            } else {
+                return MACRO( D(LCTL), T(V), U(LCTL), END  );
+            }
+            break;
+        }
+    }
+    return MACRO_NONE;
+};
+```

docs/feature_midi.md

@@ -1,260 +0,0 @@
-# MIDI
-
-## Usage
-
-First, enable MIDI by adding the following to your `rules.mk`:
-
-```makefile
-MIDI_ENABLE = yes
-```
-
-There are two MIDI systems in QMK: basic and advanced. With basic MIDI you will only be able to send Note On and Note Off messages using the note keycodes, meaning that keycodes like `MI_OCTU` and `MI_OCTD` will not work. Advanced MIDI allows you to do things like octave shifts, channel changes, velocity changes, modulation, and more.
-
-### Basic MIDI
-
-To enable basic MIDI, add the following to your `config.h`:
-
-```c
-#define MIDI_BASIC
-```
-
-### Advanced MIDI
-
-To enable advanced MIDI, add the following to your `config.h`:
-
-```c
-#define MIDI_ADVANCED
-```
-
-#### Sending Control Change (CC) Messages
-
-If you're aiming to emulate the features of something like a Launchpad or other MIDI controller you'll need to access the internal MIDI device directly.
-
-Because there are so many possible CC messages, not all of them are implemented as keycodes. Additionally, you might need to provide more than just two values that you would get from a keycode (pressed and released) - for example, the analog values from a fader or a potentiometer. So, you will need to implement [custom keycodes](feature_macros.md) if you want to use them in your keymap directly using `process_record_user()`.
-
-
-For reference of all the possible control code numbers see [MIDI Specification](#midi-specification)
-
-#### Example code for using Generic On Off Switches as per MIDI Specification.
-```c
-#include QMK_KEYBOARD_H
-
-extern MidiDevice midi_device;
-
-// MIDI CC codes for generic on/off switches (80, 81, 82, 83)
-// Off: 0-63
-// On:  64-127
-
-#define MIDI_CC_OFF 0
-#define MIDI_CC_ON  127
-
-enum custom_keycodes {
-    MIDI_CC80 = SAFE_RANGE,
-};
-
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-    switch (keycode) {
-        case MIDI_CC80:
-            if (record->event.pressed) {
-                midi_send_cc(&midi_device, midi_config.channel, 80, ON);
-            } else {
-                midi_send_cc(&midi_device, midi_config.channel, 80, OFF);
-            }
-            return true;
-    }
-    return true;
-};
-
-const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-    LAYOUT(
-        // ...
-        MIDI_CC80,
-        // ...
-    )
-};
-```
-
-### Keycodes
-
-|Keycode     |Aliases  |Description                      |
-|------------|---------|---------------------------------|
-|`MI_ON`     |         |Turn MIDI on                     |
-|`MI_OFF`    |         |Turn MIDI off                    |
-|`MI_TOG`    |         |Toggle MIDI enabled              |
-|`MI_C`      |         |C octave 0                       |
-|`MI_Cs`     |`MI_Db`  |C♯/D♭ octave 0                   |
-|`MI_D`      |         |D octave 0                       |
-|`MI_Ds`     |`MI_Eb`  |D♯/E♭ octave 0                   |
-|`MI_E`      |         |E octave 0                       |
-|`MI_F`      |         |F octave 0                       |
-|`MI_Fs`     |`MI_Gb`  |F♯/G♭ octave 0                   |
-|`MI_G`      |         |G octave 0                       |
-|`MI_Gs`     |`MI_Gs`  |G♯/A♭ octave 0                   |
-|`MI_A`      |         |A octave 0                       |
-|`MI_As`     |`MI_Bb`  |A♯/B♭ octave 0                   |
-|`MI_B`      |         |B octave 0                       |
-|`MI_C_1`    |         |C octave 1                       |
-|`MI_Cs_1`   |`MI_Db_1`|C♯/D♭ octave 1                   |
-|`MI_D_1`    |         |D octave 1                       |
-|`MI_Ds_1`   |`MI_Eb_1`|D♯/E♭ octave 1                   |
-|`MI_E_1`    |         |E octave 1                       |
-|`MI_F_1`    |         |F octave 1                       |
-|`MI_Fs_1`   |`MI_Gb_1`|F♯/G♭ octave 1                   |
-|`MI_G_1`    |         |G octave 1                       |
-|`MI_Gs_1`   |`MI_Ab_1`|G♯/A♭ octave 1                   |
-|`MI_A_1`    |         |A octave 1                       |
-|`MI_As_1`   |`MI_Bb_1`|A♯/B♭ octave 1                   |
-|`MI_B_1`    |         |B octave 1                       |
-|`MI_C_2`    |         |C octave 2                       |
-|`MI_Cs_2`   |`MI_Db_2`|C♯/D♭ octave 2                   |
-|`MI_D_2`    |         |D octave 2                       |
-|`MI_Ds_2`   |`MI_Eb_2`|D♯/E♭ octave 2                   |
-|`MI_E_2`    |         |E octave 2                       |
-|`MI_F_2`    |         |F octave 2                       |
-|`MI_Fs_2`   |`MI_Gb_2`|F♯/G♭ octave 2                   |
-|`MI_G_2`    |         |G octave 2                       |
-|`MI_Gs_2`   |`MI_Ab_2`|G♯/A♭ octave 2                   |
-|`MI_A_2`    |         |A octave 2                       |
-|`MI_As_2`   |`MI_Bb_2`|A♯/B♭ octave 2                   |
-|`MI_B_2`    |         |B octave 2                       |
-|`MI_C_3`    |         |C octave 3                       |
-|`MI_Cs_3`   |`MI_Db_3`|C♯/D♭ octave 3                   |
-|`MI_D_3`    |         |D octave 3                       |
-|`MI_Ds_3`   |`MI_Eb_3`|D♯/E♭ octave 3                   |
-|`MI_E_3`    |         |E octave 3                       |
-|`MI_F_3`    |         |F octave 3                       |
-|`MI_Fs_3`   |`MI_Gb_3`|F♯/G♭ octave 3                   |
-|`MI_G_3`    |         |G octave 3                       |
-|`MI_Gs_3`   |`MI_Ab_3`|G♯/A♭ octave 3                   |
-|`MI_A_3`    |         |A octave 3                       |
-|`MI_As_3`   |`MI_Bb_3`|A♯/B♭ octave 3                   |
-|`MI_B_3`    |         |B octave 3                       |
-|`MI_C_4`    |         |C octave 4                       |
-|`MI_Cs_4`   |`MI_Db_4`|C♯/D♭ octave 4                   |
-|`MI_D_4`    |         |D octave 4                       |
-|`MI_Ds_4`   |`MI_Eb_4`|D♯/E♭ octave 4                   |
-|`MI_E_4`    |         |E octave 4                       |
-|`MI_F_4`    |         |F octave 4                       |
-|`MI_Fs_4`   |`MI_Gb_4`|F♯/G♭ octave 4                   |
-|`MI_G_4`    |         |G octave 4                       |
-|`MI_Gs_4`   |`MI_Ab_4`|G♯/A♭ octave 4                   |
-|`MI_A_4`    |         |A octave 4                       |
-|`MI_As_4`   |`MI_Bb_4`|A♯/B♭ octave 4                   |
-|`MI_B_4`    |         |B octave 4                       |
-|`MI_C_5`    |         |C octave 5                       |
-|`MI_Cs_5`   |`MI_Db_5`|C♯/D♭ octave 5                   |
-|`MI_D_5`    |         |D octave 5                       |
-|`MI_Ds_5`   |`MI_Eb_5`|D♯/E♭ octave 5                   |
-|`MI_E_5`    |         |E octave 5                       |
-|`MI_F_5`    |         |F octave 5                       |
-|`MI_Fs_5`   |`MI_Gb_5`|F♯/G♭ octave 5                   |
-|`MI_G_5`    |         |G octave 5                       |
-|`MI_Gs_5`   |`MI_Ab_5`|G♯/A♭ octave 5                   |
-|`MI_A_5`    |         |A octave 5                       |
-|`MI_As_5`   |`MI_Bb_5`|A♯/B♭ octave 5                   |
-|`MI_B_5`    |         |B octave 5                       |
-|`MI_OCT_N2` |         |Set octave to -2                 |
-|`MI_OCT_N1` |         |Set octave to -1                 |
-|`MI_OCT_0`  |         |Set octave to 0                  |
-|`MI_OCT_1`  |         |Set octave to 1                  |
-|`MI_OCT_2`  |         |Set octave to 2                  |
-|`MI_OCT_3`  |         |Set octave to 3                  |
-|`MI_OCT_4`  |         |Set octave to 4                  |
-|`MI_OCT_5`  |         |Set octave to 5                  |
-|`MI_OCT_6`  |         |Set octave to 6                  |
-|`MI_OCT_7`  |         |Set octave to 7                  |
-|`MI_OCTD`   |         |Move down an octave              |
-|`MI_OCTU`   |         |Move up an octave                |
-|`MI_TRNS_N6`|         |Set transposition to -6 semitones|
-|`MI_TRNS_N5`|         |Set transposition to -5 semitones|
-|`MI_TRNS_N4`|         |Set transposition to -4 semitones|
-|`MI_TRNS_N3`|         |Set transposition to -3 semitones|
-|`MI_TRNS_N2`|         |Set transposition to -2 semitones|
-|`MI_TRNS_N1`|         |Set transposition to -1 semitone |
-|`MI_TRNS_0` |         |No transposition                 |
-|`MI_TRNS_1` |         |Set transposition to +1 semitone |
-|`MI_TRNS_2` |         |Set transposition to +2 semitones|
-|`MI_TRNS_3` |         |Set transposition to +3 semitones|
-|`MI_TRNS_4` |         |Set transposition to +4 semitones|
-|`MI_TRNS_5` |         |Set transposition to +5 semitones|
-|`MI_TRNS_6` |         |Set transposition to +6 semitones|
-|`MI_TRNSD`  |         |Decrease transposition           |
-|`MI_TRNSU`  |         |Increase transposition           |
-|`MI_VEL_0`  |         |Set velocity to 0                |
-|`MI_VEL_1`  |         |Set velocity to 12               |
-|`MI_VEL_2`  |         |Set velocity to 25               |
-|`MI_VEL_3`  |         |Set velocity to 38               |
-|`MI_VEL_4`  |         |Set velocity to 51               |
-|`MI_VEL_5`  |         |Set velocity to 64               |
-|`MI_VEL_6`  |         |Set velocity to 76               |
-|`MI_VEL_7`  |         |Set velocity to 89               |
-|`MI_VEL_8`  |         |Set velocity to 102              |
-|`MI_VEL_9`  |         |Set velocity to 114              |
-|`MI_VEL_10` |         |Set velocity to 127              |
-|`MI_VELD`   |         |Decrease velocity                |
-|`MI_VELU`   |         |Increase velocity                |
-|`MI_CH1`    |         |Set channel to 1                 |
-|`MI_CH2`    |         |Set channel to 2                 |
-|`MI_CH3`    |         |Set channel to 3                 |
-|`MI_CH4`    |         |Set channel to 4                 |
-|`MI_CH5`    |         |Set channel to 5                 |
-|`MI_CH6`    |         |Set channel to 6                 |
-|`MI_CH7`    |         |Set channel to 7                 |
-|`MI_CH8`    |         |Set channel to 8                 |
-|`MI_CH9`    |         |Set channel to 9                 |
-|`MI_CH10`   |         |Set channel to 10                |
-|`MI_CH11`   |         |Set channel to 11                |
-|`MI_CH12`   |         |Set channel to 12                |
-|`MI_CH13`   |         |Set channel to 13                |
-|`MI_CH14`   |         |Set channel to 14                |
-|`MI_CH15`   |         |Set channel to 15                |
-|`MI_CH16`   |         |Set channel to 16                |
-|`MI_CHD`    |         |Decrease channel                 |
-|`MI_CHU`    |         |Increase channel                 |
-|`MI_ALLOFF` |         |Stop all notes                   |
-|`MI_SUS`    |         |Sustain                          |
-|`MI_PORT`   |         |Portmento                        |
-|`MI_SOST`   |         |Sostenuto                        |
-|`MI_SOFT`   |         |Soft Pedal                       |
-|`MI_LEG`    |         |Legato                           |
-|`MI_MOD`    |         |Modulation                       |
-|`MI_MODSD`  |         |Decrease modulation speed        |
-|`MI_MODSU`  |         |Increase modulation speed        |
-|`MI_BENDD`  |         |Bend pitch down                  |
-|`MI_BENDU`  |         |Bend pitch up                    |
-
-### Configuration
-
-Certain values are stored in the `midi_config` struct. This configuration is not persisted to EEPROM. By default, these values are:
-
-|Configuration      |Value|Comments                 |
-|-------------------|-----|-------------------------|
-|Octave             |`4`  |Corresponds to `MI_OCT_2`|
-|Transposition      |`0`  |                         |
-|Velocity           |`127`|                         |
-|Channel            |`0`  |                         |
-|Modulation Interval|`8`  |                         |
-
-For the above, the `MI_C` keycode will produce a C3 (note number 48), and so on.
-
-### References
-#### MIDI Specification
-
- * [MIDI.org](https://www.midi.org/specifications-old/item/table-1-summary-of-midi-message)
- * [CMU MIDI Programmer's Reference](https://www.cs.cmu.edu/~music/cmsip/readings/MIDI%20tutorial%20for%20programmers.html)
-#### QMK C Files
-
- * `quantum/process_keycode/process_midi.c`
- * `quantum/quantum_keycodes.h`
- * `tmk_core/protocol/midi.h`
- * `tmk_core/protocol/midi.c`
- * `tmk_core/protocol/qmk_midi.c`
- * `tmk_core/protocol/midi_device.h`
-
-<!--
-#### QMK Internals (Autogenerated)
- 
- * [Internals/MIDI Device Setup Process](internals_midi_device_setup_process.md)
- * [Internals/MIDI Device](internals_midi_device.md)
- * [Internals/MIDI Util](internals_midi_util.md)
--->

docs/feature_mouse_keys.md

@@ -29,9 +29,6 @@ In your keymap you can use the following keycodes to map key presses to mouse ac
 |`KC_MS_BTN3`    |`KC_BTN3`|Press button 3   |
 |`KC_MS_BTN4`    |`KC_BTN4`|Press button 4   |
 |`KC_MS_BTN5`    |`KC_BTN5`|Press button 5   |
-|`KC_MS_BTN6`    |`KC_BTN6`|Press button 6   |
-|`KC_MS_BTN7`    |`KC_BTN7`|Press button 7   |
-|`KC_MS_BTN8`    |`KC_BTN8`|Press button 8   |
 |`KC_MS_WH_UP`   |`KC_WH_U`|Move wheel up    |
 |`KC_MS_WH_DOWN` |`KC_WH_D`|Move wheel down  |
 |`KC_MS_WH_LEFT` |`KC_WH_L`|Move wheel left  |
@@ -45,7 +42,6 @@ In your keymap you can use the following keycodes to map key presses to mouse ac
 Mouse keys supports three different modes to move the cursor:
 
 * **Accelerated (default):** Holding movement keys accelerates the cursor until it reaches its maximum speed.
-* **Kinetic:** Holding movement keys accelerates the cursor with its speed following a quadratic curve until it reaches its maximum speed.
 * **Constant:** Holding movement keys moves the cursor at constant speeds.
 * **Combined:** Holding movement keys accelerates the cursor until it reaches its maximum speed, but holding acceleration and movement keys simultaneously moves the cursor at constant speeds.
 
@@ -60,8 +56,7 @@ This is the default mode. You can adjust the cursor and scrolling acceleration u
 |Define                      |Default|Description                                              |
 |----------------------------|-------|---------------------------------------------------------|
 |`MOUSEKEY_DELAY`            |300    |Delay between pressing a movement key and cursor movement|
-|`MOUSEKEY_INTERVAL`         |50     |Time between cursor movements in milliseconds            |
-|`MOUSEKEY_MOVE_DELTA`       |5      |Step size                                                |
+|`MOUSEKEY_INTERVAL`         |50     |Time between cursor movements                            |
 |`MOUSEKEY_MAX_SPEED`        |10     |Maximum cursor speed at which acceleration stops         |
 |`MOUSEKEY_TIME_TO_MAX`      |20     |Time until maximum cursor speed is reached               |
 |`MOUSEKEY_WHEEL_DELAY`      |300    |Delay between pressing a wheel key and wheel movement    |
@@ -78,30 +73,6 @@ Tips:
 
 Cursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).
 
-### Kinetic Mode
-
-This is an extension of the accelerated mode. The kinetic mode uses a quadratic curve on the cursor speed which allows precise movements at the beginning and allows to cover large distances by increasing cursor speed quickly thereafter.  You can adjust the cursor and scrolling acceleration using the following settings in your keymap’s `config.h` file:
-
-|Define                                |Default  |Description                                                    |
-|--------------------------------------|---------|---------------------------------------------------------------|
-|`MK_KINETIC_SPEED`                    |undefined|Enable kinetic mode                                            |
-|`MOUSEKEY_DELAY`                      |8        |Delay between pressing a movement key and cursor movement      |
-|`MOUSEKEY_INTERVAL`                   |8        |Time between cursor movements in milliseconds                  |
-|`MOUSEKEY_MOVE_DELTA`                 |25       |Step size for accelerating from initial to base speed          |
-|`MOUSEKEY_INITIAL_SPEED`              |100      |Initial speed of the cursor in pixel per second                |
-|`MOUSEKEY_BASE_SPEED`                 |1000     |Maximum cursor speed at which acceleration stops               |
-|`MOUSEKEY_DECELERATED_SPEED`          |400      |Decelerated cursor speed                                       |
-|`MOUSEKEY_ACCELERATED_SPEED`          |3000     |Accelerated cursor speed                                       |
-|`MOUSEKEY_WHEEL_INITIAL_MOVEMENTS`    |16       |Initial number of movements of the mouse wheel                 |
-|`MOUSEKEY_WHEEL_BASE_MOVEMENTS`       |32       |Maximum number of movements at which acceleration stops        |
-|`MOUSEKEY_WHEEL_ACCELERATED_MOVEMENTS`|48       |Accelerated wheel movements                                    |
-|`MOUSEKEY_WHEEL_DECELERATED_MOVEMENTS`|8        |Decelerated wheel movements                                    |
-
-Tips:
-
-* The smoothness of the cursor movement depends on the `MOUSEKEY_INTERVAL` setting. The shorter the interval is set the smoother the movement will be.  Setting the value too low makes the cursor unresponsive.  Lower settings are possible if the micro processor is fast enough. For example: At an interval of `8` milliseconds, `125` movements per second will be initiated.  With a base speed of `1000` each movement will move the cursor by `8` pixels.
-* Mouse wheel movements are implemented differently from cursor movements. While it's okay for the cursor to move multiple pixels at once for the mouse wheel this would lead to jerky movements. Instead, the mouse wheel operates at step size `1`. Setting mouse wheel speed is done by adjusting the number of wheel movements per second.
-
 ### Constant mode
 
 In this mode you can define multiple different speeds for both the cursor and the mouse wheel. There is no acceleration. `KC_ACL0`, `KC_ACL1` and `KC_ACL2` change the cursor and scroll speed to their respective setting.

docs/feature_oled_driver.md

@@ -21,23 +21,13 @@ Hardware configurations using Arm-based microcontrollers or different sizes of O
 To enable the OLED feature, there are three steps. First, when compiling your keyboard, you'll need to add the following to your `rules.mk`:
 
 ```make
-OLED_ENABLE = yes
-```
-
-## OLED type
-|OLED Driver        |Supported Device           |
-|-------------------|---------------------------|
-|SSD1306 (default)  |For both SSD1306 and SH1106|
-
-e.g.
-```make
-OLED_DRIVER = SSD1306
+OLED_DRIVER_ENABLE = yes
 ```
 
 Then in your `keymap.c` file, implement the OLED task call. This example assumes your keymap has three layers named `_QWERTY`, `_FN` and `_ADJ`:
 
 ```c
-#ifdef OLED_ENABLE
+#ifdef OLED_DRIVER_ENABLE
 void oled_task_user(void) {
     // Host Keyboard Layer Status
     oled_write_P(PSTR("Layer: "), false);
@@ -124,7 +114,7 @@ static void fade_display(void) {
 In split keyboards, it is very common to have two OLED displays that each render different content and are oriented or flipped differently. You can do this by switching which content to render by using the return value from `is_keyboard_master()` or `is_keyboard_left()` found in `split_util.h`, e.g:
 
 ```c
-#ifdef OLED_ENABLE
+#ifdef OLED_DRIVER_ENABLE
 oled_rotation_t oled_init_user(oled_rotation_t rotation) {
     if (!is_keyboard_master()) {
         return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
@@ -155,8 +145,6 @@ void oled_task_user(void) {
 |`OLED_FONT_WIDTH`          |`6`              |The font width                                                                                                            |
 |`OLED_FONT_HEIGHT`         |`8`              |The font height (untested)                                                                                                |
 |`OLED_TIMEOUT`             |`60000`          |Turns off the OLED screen after 60000ms of keyboard inactivity. Helps reduce OLED Burn-in. Set to 0 to disable.           |
-|`OLED_FADE_OUT`            |*Not defined*    |Enables fade out animation. Use together with `OLED_TIMEOUT`.                                                             |
-|`OLED_FADE_OUT_INTERVAL`   |`0`              |The speed of fade out animation, from 0 to 15. Larger values are slower.                                                  |
 |`OLED_SCROLL_TIMEOUT`      |`0`              |Scrolls the OLED screen after 0ms of OLED inactivity. Helps reduce OLED Burn-in. Set to 0 to disable.                     |
 |`OLED_SCROLL_TIMEOUT_RIGHT`|*Not defined*    |Scroll timeout direction is right when defined, left when undefined.                                                      |
 |`OLED_IC`                  |`OLED_IC_SSD1306`|Set to `OLED_IC_SH1106` if you're using the SH1106 OLED controller.                                                       |
@@ -273,25 +261,11 @@ void oled_write(const char *data, bool invert);
 void oled_write_ln(const char *data, bool invert);
 
 // Pans the buffer to the right (or left by passing true) by moving contents of the buffer
-// Useful for moving the screen in preparation for new drawing
+// Useful for moving the screen in preparation for new drawing 
 // oled_scroll_left or oled_scroll_right should be preferred for all cases of moving a static
 // image such as a logo or to avoid burn-in as it's much, much less cpu intensive
 void oled_pan(bool left);
 
-// Returns a pointer to the requested start index in the buffer plus remaining
-// buffer length as struct
-oled_buffer_reader_t oled_read_raw(uint16_t start_index);
-
-// Writes a string to the buffer at current cursor position
-void oled_write_raw(const char *data, uint16_t size);
-
-// Writes a single byte into the buffer at the specified index
-void oled_write_raw_byte(const char data, uint16_t index);
-
-// Sets a specific pixel on or off
-// Coordinates start at top-left and go right and down for positive x and y
-void oled_write_pixel(uint8_t x, uint8_t y, bool on);
-
 // Writes a PROGMEM string to the buffer at current cursor position
 // Advances the cursor while writing, inverts the pixels if true
 // Remapped to call 'void oled_write(const char *data, bool invert);' on ARM
@@ -303,9 +277,23 @@ void oled_write_P(const char *data, bool invert);
 // Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM
 void oled_write_ln_P(const char *data, bool invert);
 
+// Returns a pointer to the requested start index in the buffer plus remaining
+// buffer length as struct
+oled_buffer_reader_t oled_read_raw(uint16_t start_index);
+
+// Writes a string to the buffer at current cursor position
+void oled_write_raw(const char *data, uint16_t size);
+
+// Writes a single byte into the buffer at the specified index
+void oled_write_raw_byte(const char data, uint16_t index);
+
 // Writes a PROGMEM string to the buffer at current cursor position
 void oled_write_raw_P(const char *data, uint16_t size);
 
+// Sets a specific pixel on or off
+// Coordinates start at top-left and go right and down for positive x and y
+void oled_write_pixel(uint8_t x, uint8_t y, bool on);
+
 // Can be used to manually turn on the screen if it is off
 // Returns true if the screen was on or turns on
 bool oled_on(void);
@@ -356,10 +344,6 @@ bool oled_scroll_left(void);
 // Returns true if the screen was not scrolling or stops scrolling
 bool oled_scroll_off(void);
 
-// Inverts the display
-// Returns true if the screen was or is inverted
-bool oled_invert(bool invert);
-
 // Returns the maximum number of characters that will fit on a line
 uint8_t oled_max_chars(void);
 

docs/feature_pointing_device.md

@@ -19,7 +19,7 @@ Keep in mind that a report_mouse_t (here "mouseReport") has the following proper
 * `mouseReport.y` - this is a signed int from -127 to 127 (not 128, this is defined in USB HID spec) representing movement (+ upward, - downward) on the y axis.
 * `mouseReport.v` - this is a signed int from -127 to 127 (not 128, this is defined in USB HID spec) representing vertical scrolling (+ upward, - downward).
 * `mouseReport.h` - this is a signed int from -127 to 127 (not 128, this is defined in USB HID spec) representing horizontal scrolling (+ right, - left).
-* `mouseReport.buttons` - this is a uint8_t in which all 8 bits are used.  These bits represent the mouse button state - bit 0 is mouse button 1, and bit 7 is mouse button 8.
+* `mouseReport.buttons` - this is a uint8_t in which the last 5 bits are used.  These bits represent the mouse button state - bit 3 is mouse button 5, and bit 7 is mouse button 1.
 
 Once you have made the necessary changes to the mouse report, you need to send it:
 

docs/feature_ps2_mouse.md

@@ -50,7 +50,7 @@ In your keyboard config.h:
 #endif
 ```
 
-### Interrupt Version (AVR/ATMega32u4) :id=interrupt-version-avr
+## Interrupt Version :id=interrupt-version
 
 The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.
 
@@ -88,31 +88,7 @@ In your keyboard config.h:
 #endif
 ```
 
-### Interrupt Version (ARM chibios) :id=interrupt-version-chibios
-
-Pretty much any two pins can be used for the (software) interrupt variant on ARM cores. The example below uses A8 for clock, and A9 for data.
-
-In rules.mk:
-
-```
-PS2_MOUSE_ENABLE = yes
-PS2_USE_INT = yes
-```
-
-In your keyboard config.h:
-
-```c
-#define PS2_CLOCK A8
-#define PS2_DATA  A9
-```
-
-And in the chibios specifig halconf.h:
-```c
-#define PAL_USE_CALLBACKS TRUE
-```
-
-
-### USART Version :id=usart-version
+## USART Version :id=usart-version
 
 To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.
 
@@ -270,16 +246,6 @@ Fine control over the scrolling is supported with the following defines:
 #define PS2_MOUSE_SCROLL_DIVISOR_V 2
 ```
 
-### Invert Mouse buttons :id=invert-buttons
-
-To invert the left & right buttons you can put:
-
-```c
-#define PS2_MOUSE_INVERT_BUTTONS
-```
-
-into config.h.
-
 ### Invert Mouse and Scroll Axes :id=invert-mouse-and-scroll-axes
 
 To invert the X and Y axes you can put:

docs/feature_rgb_matrix.md

@@ -15,20 +15,7 @@ RGB_MATRIX_ENABLE = yes
 RGB_MATRIX_DRIVER = IS31FL3731
 ```
 
-You can use between 1 and 4 IS31FL3731 IC's. Do not specify `DRIVER_ADDR_<N>` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
-
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `ISSI_TIMEOUT` | (Optional) How long to wait for i2c messages, in milliseconds | 100 |
-| `ISSI_PERSISTENCE` | (Optional) Retry failed messages this many times | 0 |
-| `DRIVER_COUNT` | (Required) How many RGB driver IC's are present | |
-| `DRIVER_LED_TOTAL` | (Required) How many RGB lights are present across all drivers | |
-| `DRIVER_ADDR_1` | (Required) Address for the first RGB driver | |
-| `DRIVER_ADDR_2` | (Optional) Address for the second RGB driver | |
-| `DRIVER_ADDR_3` | (Optional) Address for the third RGB driver | |
-| `DRIVER_ADDR_4` | (Optional) Address for the fourth RGB driver | |
-
-Here is an example using 2 drivers.
+Configure the hardware via your `config.h`:
 
 ```c
 // This is a 7-bit address, that gets left-shifted and bit 0
@@ -49,10 +36,12 @@ Here is an example using 2 drivers.
 
 !> Note the parentheses, this is so when `DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)` will give very different results than `rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL`.
 
+Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
+
 Define these arrays listing all the LEDs in your `<keyboard>.c`:
 
 ```c
-const is31_led __flash g_is31_leds[DRIVER_LED_TOTAL] = {
+const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
 /* Refer to IS31 manual for these locations
  *   driver
  *   |  R location
@@ -64,10 +53,12 @@ const is31_led __flash g_is31_leds[DRIVER_LED_TOTAL] = {
 }
 ```
 
-Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/led/issi/is31fl3731.h`. The `driver` is the index of the driver you defined in your `config.h` (`0`, `1`, `2`, or `3`).
+Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/issi/is31fl3731.h`. The `driver` is the index of the driver you defined in your `config.h` (`0` or `1` right now).
 
 ---
-### IS31FL3733 :id=is31fl3733
+### IS31FL3733/IS31FL3737 :id=is31fl3733is31fl3737
+
+!> For the IS31FL3737, replace all instances of `IS31FL3733` below with `IS31FL3737`.
 
 There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your `rules.mk`:
 
@@ -76,24 +67,7 @@ RGB_MATRIX_ENABLE = yes
 RGB_MATRIX_DRIVER = IS31FL3733
 ```
 
-You can use between 1 and 4 IS31FL3733 IC's. Do not specify `DRIVER_ADDR_<N>` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
-
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `ISSI_TIMEOUT` | (Optional) How long to wait for i2c messages, in milliseconds | 100 |
-| `ISSI_PERSISTENCE` | (Optional) Retry failed messages this many times | 0 |
-| `DRIVER_COUNT` | (Required) How many RGB driver IC's are present | |
-| `DRIVER_LED_TOTAL` | (Required) How many RGB lights are present across all drivers | |
-| `DRIVER_ADDR_1` | (Required) Address for the first RGB driver | |
-| `DRIVER_ADDR_2` | (Optional) Address for the second RGB driver | |
-| `DRIVER_ADDR_3` | (Optional) Address for the third RGB driver | |
-| `DRIVER_ADDR_4` | (Optional) Address for the fourth RGB driver | |
-| `DRIVER_SYNC_1` | (Optional) Sync configuration for the first RGB driver | 0 |
-| `DRIVER_SYNC_2` | (Optional) Sync configuration for the second RGB driver | 0 |
-| `DRIVER_SYNC_3` | (Optional) Sync configuration for the third RGB driver | 0 |
-| `DRIVER_SYNC_4` | (Optional) Sync configuration for the fourth RGB driver | 0 |
-
-Here is an example using 2 drivers.
+Configure the hardware via your `config.h`:
 
 ```c
 // This is a 7-bit address, that gets left-shifted and bit 0
@@ -107,22 +81,19 @@ Here is an example using 2 drivers.
 // ADDR2 represents A3:A2 of the 7-bit address.
 // The result is: 0b101(ADDR2)(ADDR1)
 #define DRIVER_ADDR_1 0b1010000
-#define DRIVER_ADDR_2 0b1010011
+#define DRIVER_ADDR_2 0b1010000 // this is here for compliancy reasons.
 
 #define DRIVER_COUNT 2
-#define DRIVER_1_LED_TOTAL 58
-#define DRIVER_2_LED_TOTAL 10
-#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
+#define DRIVER_1_LED_TOTAL 64
+#define DRIVER_LED_TOTAL DRIVER_1_LED_TOTAL
 ```
 
-!> Note the parentheses, this is so when `DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)` will give very different results than `rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL`.
-
-Currently only 4 drivers are supported, but it would be trivial to support all 8 combinations.
+Currently only a single drivers is supported, but it would be trivial to support all 4 combinations. For now define `DRIVER_ADDR_2` as `DRIVER_ADDR_1`
 
 Define these arrays listing all the LEDs in your `<keyboard>.c`:
 
 ```c
-const is31_led __flash g_is31_leds[DRIVER_LED_TOTAL] = {
+const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
 /* Refer to IS31 manual for these locations
  *   driver
  *   |  R location
@@ -134,71 +105,7 @@ const is31_led __flash g_is31_leds[DRIVER_LED_TOTAL] = {
 }
 ```
 
-Where `X_Y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3733.pdf) and the header file `drivers/led/issi/is31fl3733.h`. The `driver` is the index of the driver you defined in your `config.h` (`0`, `1`, `2`, or `3` for now).
-
----
-### IS31FL3737 :id=is31fl3737
-
-There is basic support for addressable RGB matrix lighting with the I2C IS31FL3737 RGB controller. To enable it, add this to your `rules.mk`:
-
-```makefile
-RGB_MATRIX_ENABLE = yes
-RGB_MATRIX_DRIVER = IS31FL3737
-```
-You can use between 1 and 2 IS31FL3737 IC's. Do not specify `DRIVER_ADDR_2` define for second IC if not present on your keyboard.
-
-Configure the hardware via your `config.h`:
-
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `ISSI_TIMEOUT` | (Optional) How long to wait for i2c messages, in milliseconds | 100 |
-| `ISSI_PERSISTENCE` | (Optional) Retry failed messages this many times | 0 |
-| `DRIVER_COUNT` | (Required) How many RGB driver IC's are present | |
-| `DRIVER_LED_TOTAL` | (Required) How many RGB lights are present across all drivers | |
-| `DRIVER_ADDR_1` | (Required) Address for the first RGB driver | |
-| `DRIVER_ADDR_2` | (Optional) Address for the second RGB driver | |
-
-
-Here is an example using 2 drivers.
-
-```c
-// This is a 7-bit address, that gets left-shifted and bit 0
-// set to 0 for write, 1 for read (as per I2C protocol)
-// The address will vary depending on your wiring:
-// 0000 <-> GND
-// 0101 <-> SCL
-// 1010 <-> SDA
-// 1111 <-> VCC
-// ADDR represents A3:A0 of the 7-bit address.
-// The result is: 0b101(ADDR)
-#define DRIVER_ADDR_1 0b1010000
-#define DRIVER_ADDR_2 0b1010001
-
-#define DRIVER_COUNT 2
-#define DRIVER_1_LED_TOTAL 30
-#define DRIVER_2_LED_TOTAL 36
-#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
-```
-!> Note the parentheses, this is so when `DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)` will give very different results than `rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL`.
-
-Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations. 
-
-Define these arrays listing all the LEDs in your `<keyboard>.c`:
-
-```c
-const is31_led __flash g_is31_leds[DRIVER_LED_TOTAL] = {
-/* Refer to IS31 manual for these locations
- *   driver
- *   |  R location
- *   |  |       G location
- *   |  |       |       B location
- *   |  |       |       | */
-    {0, B_1,    A_1,    C_1},
-    ....
-}
-```
-
-Where `X_Y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3737.pdf) and the header file `drivers/led/issi/is31fl3737.h`. The `driver` is the index of the driver you defined in your `config.h` (Only `0`, `1` for now).
+Where `X_Y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3733.pdf) and the header file `drivers/issi/is31fl3733.h`. The `driver` is the index of the driver you defined in your `config.h` (Only `0` right now).
 
 ---
 
@@ -222,99 +129,6 @@ Configure the hardware via your `config.h`:
 
 ---
 
-### APA102 :id=apa102
-
-There is basic support for APA102 based addressable LED strands. To enable it, add this to your `rules.mk`:
-
-```makefile
-RGB_MATRIX_ENABLE = yes
-RGB_MATRIX_DRIVER = APA102
-```
-
-Configure the hardware via your `config.h`:
-
-```c
-// The pin connected to the data pin of the LEDs
-#define RGB_DI_PIN D7
-// The pin connected to the clock pin of the LEDs
-#define RGB_CI_PIN D6
-// The number of LEDs connected
-#define DRIVER_LED_TOTAL 70
-```
-
----
-### AW20216 :id=aw20216
-There is basic support for addressable RGB matrix lighting with the SPI AW20216 RGB controller. To enable it, add this to your `rules.mk`:
-
-```makefile
-RGB_MATRIX_ENABLE = yes
-RGB_MATRIX_DRIVER = AW20216
-```
-
-You can use up to 2 AW20216 IC's. Do not specify `DRIVER_<N>_xxx` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
-
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `DRIVER_1_CS` | (Required) MCU pin connected to first RGB driver chip select line  | B13 |
-| `DRIVER_2_CS` | (Optional) MCU pin connected to second RGB driver chip select line  | |
-| `DRIVER_1_EN` | (Required) MCU pin connected to first RGB driver hardware enable line  | C13 |
-| `DRIVER_2_EN` | (Optional) MCU pin connected to second RGB driver hardware enable line  | |
-| `DRIVER_1_LED_TOTAL` | (Required) How many RGB lights are connected to first RGB driver  | |
-| `DRIVER_2_LED_TOTAL` | (Optional) How many RGB lights are connected to second RGB driver  | |
-| `DRIVER_COUNT` | (Required) How many RGB driver IC's are present | |
-| `DRIVER_LED_TOTAL` | (Required) How many RGB lights are present across all drivers | |
-| `AW_SCALING_MAX` | (Optional) LED current scaling value (0-255, higher values mean LED is brighter at full PWM) | 150 |
-| `AW_GLOBAL_CURRENT_MAX` | (Optional) Driver global current limit (0-255, higher values means the driver may consume more power) | 150 |
-| `AW_SPI_DIVISOR` | (Optional) Clock divisor for SPI communication (powers of 2, smaller numbers means faster communication, should not be less than 4) | 4 |
-
-Here is an example using 2 drivers.
-
-```c
-#define DRIVER_1_CS B13
-#define DRIVER_2_CS B14
-// Hardware enable lines may be connected to the same pin
-#define DRIVER_1_EN C13
-#define DRIVER_2_EN C13
-
-#define DRIVER_COUNT 2
-#define DRIVER_1_LED_TOTAL 66
-#define DRIVER_2_LED_TOTAL 32
-#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
-```
-
-!> Note the parentheses, this is so when `DRIVER_LED_TOTAL` is used in code and expanded, the values are added together before any additional math is applied to them. As an example, `rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)` will give very different results than `rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL`.
-
-Define these arrays listing all the LEDs in your `<keyboard>.c`:
-
-```c
-const aw_led __flash g_aw_leds[DRIVER_LED_TOTAL] = {
-/* Each AW20216 channel is controlled by a register at some offset between 0x00
- * and 0xD7 inclusive.
- * See drivers/awinic/aw20216.h for the mapping between register offsets and
- * driver pin locations.
- *    driver
- *    |  R location
- *    |  |        G location
- *    |  |        |        B location
- *    |  |        |        | */
-    { 0, CS1_SW1, CS2_SW1, CS3_SW1 },
-    { 0, CS4_SW1, CS5_SW1, CS6_SW1 },
-    { 0, CS7_SW1, CS8_SW1, CS9_SW1 },
-    { 0, CS10_SW1, CS11_SW1, CS12_SW1 },
-    { 0, CS13_SW1, CS14_SW1, CS15_SW1 },
-    ...
-    { 1, CS1_SW1, CS2_SW1, CS3_SW1 },
-    { 1, CS13_SW1, CS14_SW1, CS15_SW1 },
-    { 1, CS16_SW1, CS17_SW1, CS18_SW1 },
-    { 1, CS4_SW2, CS5_SW2, CS6_SW2 },
-    ...
-};
-```
-
----
-
-## Common Configuration :id=common-configuration
-
 From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:
 
 ```c
@@ -418,9 +232,6 @@ enum rgb_matrix_effects {
     RGB_MATRIX_RAINBOW_PINWHEELS,   // Full dual gradients spinning two halfs of keyboard
     RGB_MATRIX_RAINDROPS,           // Randomly changes a single key's hue
     RGB_MATRIX_JELLYBEAN_RAINDROPS, // Randomly changes a single key's hue and saturation
-    RGB_MATRIX_HUE_BREATHING,       // Hue shifts up a slight ammount at the same time, then shifts back
-    RGB_MATRIX_HUE_PENDULUM,        // Hue shifts up a slight ammount in a wave to the right, then back to the left
-    RGB_MATRIX_HUE_WAVE,            // Hue shifts up a slight ammount and then back down in a wave to the right 
 #if define(RGB_MATRIX_FRAMEBUFFER_EFFECTS)
     RGB_MATRIX_TYPING_HEATMAP,      // How hot is your WPM!
     RGB_MATRIX_DIGITAL_RAIN,        // That famous computer simulation
@@ -448,46 +259,42 @@ You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `con
 
 |Define                                                 |Description                                    |
 |-------------------------------------------------------|-----------------------------------------------|
-|`#define ENABLE_RGB_MATRIX_ALPHAS_MODS`               |Enables `RGB_MATRIX_ALPHAS_MODS`              |
-|`#define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN`          |Enables `RGB_MATRIX_GRADIENT_UP_DOWN`         |
-|`#define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT`       |Enables `MATRIX_GRADIENT_LEFT_RIGHT`          |
-|`#define ENABLE_RGB_MATRIX_BREATHING`                 |Enables `RGB_MATRIX_BREATHING`                |
-|`#define ENABLE_RGB_MATRIX_BAND_SAT`                  |Enables `RGB_MATRIX_BAND_SAT`                 |
-|`#define ENABLE_RGB_MATRIX_BAND_VAL`                  |Enables `RGB_MATRIX_BAND_VAL`                 |
-|`#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT`         |Enables `RGB_MATRIX_BAND_PINWHEEL_SAT`        |
-|`#define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL`         |Enables `RGB_MATRIX_BAND_PINWHEEL_VAL`        |
-|`#define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT`           |Enables `RGB_MATRIX_BAND_SPIRAL_SAT`          |
-|`#define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL`           |Enables `RGB_MATRIX_BAND_SPIRAL_VAL`          |
-|`#define ENABLE_RGB_MATRIX_CYCLE_ALL`                 |Enables `RGB_MATRIX_CYCLE_ALL`                |
-|`#define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT`          |Enables `RGB_MATRIX_CYCLE_LEFT_RIGHT`         |
-|`#define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN`             |Enables `RGB_MATRIX_CYCLE_UP_DOWN`            |
-|`#define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON`    |Enables `RGB_MATRIX_RAINBOW_MOVING_CHEVRON`   |
-|`#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN`              |Enables `RGB_MATRIX_CYCLE_OUT_IN`             |
-|`#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL`         |Enables `RGB_MATRIX_CYCLE_OUT_IN_DUAL`        |
-|`#define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL`            |Enables `RGB_MATRIX_CYCLE_PINWHEEL`           |
-|`#define ENABLE_RGB_MATRIX_CYCLE_SPIRAL`              |Enables `RGB_MATRIX_CYCLE_SPIRAL`             |
-|`#define ENABLE_RGB_MATRIX_DUAL_BEACON`               |Enables `RGB_MATRIX_DUAL_BEACON`              |
-|`#define ENABLE_RGB_MATRIX_RAINBOW_BEACON`            |Enables `RGB_MATRIX_RAINBOW_BEACON`           |
-|`#define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS`         |Enables `RGB_MATRIX_RAINBOW_PINWHEELS`        |
-|`#define ENABLE_RGB_MATRIX_RAINDROPS`                 |Enables `RGB_MATRIX_RAINDROPS`                |
-|`#define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS`       |Enables `RGB_MATRIX_JELLYBEAN_RAINDROPS`      |
-|`#define ENABLE_RGB_MATRIX_HUE_BREATHING`             |Enables `RGB_MATRIX_HUE_BREATHING`            |
-|`#define ENABLE_RGB_MATRIX_HUE_PENDULUM`              |Enables `RGB_MATRIX_HUE_PENDULUM`             |
-|`#define ENABLE_RGB_MATRIX_HUE_WAVE `                 |Enables `RGB_MATRIX_HUE_WAVE `                |
-|`#define ENABLE_RGB_MATRIX_TYPING_HEATMAP`            |Enables `RGB_MATRIX_TYPING_HEATMAP`           |
-|`#define ENABLE_RGB_MATRIX_DIGITAL_RAIN`              |Enables `RGB_MATRIX_DIGITAL_RAIN`             |
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE`     |Enables `RGB_MATRIX_SOLID_REACTIVE_SIMPLE`    |
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE`            |Enables `RGB_MATRIX_SOLID_REACTIVE`           |
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE`       |Enables `RGB_MATRIX_SOLID_REACTIVE_WIDE`      |
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE`  |Enables `RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE` |
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS`      |Enables `RGB_MATRIX_SOLID_REACTIVE_CROSS`     |
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS` |Enables `RGB_MATRIX_SOLID_REACTIVE_MULTICROSS`|
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS`      |Enables `RGB_MATRIX_SOLID_REACTIVE_NEXUS`     |
-|`#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS` |Enables `RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS`|
-|`#define ENABLE_RGB_MATRIX_SPLASH`                    |Enables `RGB_MATRIX_SPLASH`                   |
-|`#define ENABLE_RGB_MATRIX_MULTISPLASH`               |Enables `RGB_MATRIX_MULTISPLASH`              |
-|`#define ENABLE_RGB_MATRIX_SOLID_SPLASH`              |Enables `RGB_MATRIX_SOLID_SPLASH`             |
-|`#define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH`         |Enables `RGB_MATRIX_SOLID_MULTISPLASH`        |
+|`#define DISABLE_RGB_MATRIX_ALPHAS_MODS`               |Disables `RGB_MATRIX_ALPHAS_MODS`              |
+|`#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN`          |Disables `RGB_MATRIX_GRADIENT_UP_DOWN`         |
+|`#define DISABLE_RGB_MATRIX_BREATHING`                 |Disables `RGB_MATRIX_BREATHING`                |
+|`#define DISABLE_RGB_MATRIX_BAND_SAT`                  |Disables `RGB_MATRIX_BAND_SAT`                 |
+|`#define DISABLE_RGB_MATRIX_BAND_VAL`                  |Disables `RGB_MATRIX_BAND_VAL`                 |
+|`#define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT`         |Disables `RGB_MATRIX_BAND_PINWHEEL_SAT`        |
+|`#define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL`         |Disables `RGB_MATRIX_BAND_PINWHEEL_VAL`        |
+|`#define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT`           |Disables `RGB_MATRIX_BAND_SPIRAL_SAT`          |
+|`#define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL`           |Disables `RGB_MATRIX_BAND_SPIRAL_VAL`          |
+|`#define DISABLE_RGB_MATRIX_CYCLE_ALL`                 |Disables `RGB_MATRIX_CYCLE_ALL`                |
+|`#define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT`          |Disables `RGB_MATRIX_CYCLE_LEFT_RIGHT`         |
+|`#define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN`             |Disables `RGB_MATRIX_CYCLE_UP_DOWN`            |
+|`#define DISABLE_RGB_MATRIX_CYCLE_OUT_IN`              |Disables `RGB_MATRIX_CYCLE_OUT_IN`             |
+|`#define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL`         |Disables `RGB_MATRIX_CYCLE_OUT_IN_DUAL`        |
+|`#define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON`    |Disables `RGB_MATRIX_RAINBOW_MOVING_CHEVRON`   |
+|`#define DISABLE_RGB_MATRIX_DUAL_BEACON`               |Disables `RGB_MATRIX_DUAL_BEACON`              |
+|`#define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL`            |Disables `RGB_MATRIX_CYCLE_PINWHEEL`           |
+|`#define DISABLE_RGB_MATRIX_CYCLE_SPIRAL`              |Disables `RGB_MATRIX_CYCLE_SPIRAL`             |
+|`#define DISABLE_RGB_MATRIX_RAINBOW_BEACON`            |Disables `RGB_MATRIX_RAINBOW_BEACON`           |
+|`#define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS`         |Disables `RGB_MATRIX_RAINBOW_PINWHEELS`        |
+|`#define DISABLE_RGB_MATRIX_RAINDROPS`                 |Disables `RGB_MATRIX_RAINDROPS`                |
+|`#define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS`       |Disables `RGB_MATRIX_JELLYBEAN_RAINDROPS`      |
+|`#define DISABLE_RGB_MATRIX_TYPING_HEATMAP`            |Disables `RGB_MATRIX_TYPING_HEATMAP`           |
+|`#define DISABLE_RGB_MATRIX_DIGITAL_RAIN`              |Disables `RGB_MATRIX_DIGITAL_RAIN`             |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE`            |Disables `RGB_MATRIX_SOLID_REACTIVE`           |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE`     |Disables `RGB_MATRIX_SOLID_REACTIVE_SIMPLE`    |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE`       |Disables `RGB_MATRIX_SOLID_REACTIVE_WIDE`      |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE`  |Disables `RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE` |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS`      |Disables `RGB_MATRIX_SOLID_REACTIVE_CROSS`     |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS` |Disables `RGB_MATRIX_SOLID_REACTIVE_MULTICROSS`|
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS`      |Disables `RGB_MATRIX_SOLID_REACTIVE_NEXUS`     |
+|`#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS` |Disables `RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS`|
+|`#define DISABLE_RGB_MATRIX_SPLASH`                    |Disables `RGB_MATRIX_SPLASH`                   |
+|`#define DISABLE_RGB_MATRIX_MULTISPLASH`               |Disables `RGB_MATRIX_MULTISPLASH`              |
+|`#define DISABLE_RGB_MATRIX_SOLID_SPLASH`              |Disables `RGB_MATRIX_SOLID_SPLASH`             |
+|`#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH`         |Disables `RGB_MATRIX_SOLID_MULTISPLASH`        |
 
 ### RGB Matrix Effect Typing Heatmap :id=rgb-matrix-effect-typing-heatmap
 
@@ -562,36 +369,35 @@ static bool my_cool_effect2(effect_params_t* params) {
 #endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS
 ```
 
-For inspiration and examples, check out the built-in effects under `quantum/rgb_matrix_animations/`
+For inspiration and examples, check out the built-in effects under `quantum/rgb_matrix_animation/`
 
 
 ## Colors :id=colors
 
 These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions.
 
-|RGB                  |HSV                  |
-|---------------------|---------------------|
-|`RGB_AZURE`          |`HSV_AZURE`          |
-|`RGB_BLACK`/`RGB_OFF`|`HSV_BLACK`/`HSV_OFF`|
-|`RGB_BLUE`           |`HSV_BLUE`           |
-|`RGB_CHARTREUSE`     |`HSV_CHARTREUSE`     |
-|`RGB_CORAL`          |`HSV_CORAL`          |
-|`RGB_CYAN`           |`HSV_CYAN`           |
-|`RGB_GOLD`           |`HSV_GOLD`           |
-|`RGB_GOLDENROD`      |`HSV_GOLDENROD`      |
-|`RGB_GREEN`          |`HSV_GREEN`          |
-|`RGB_MAGENTA`        |`HSV_MAGENTA`        |
-|`RGB_ORANGE`         |`HSV_ORANGE`         |
-|`RGB_PINK`           |`HSV_PINK`           |
-|`RGB_PURPLE`         |`HSV_PURPLE`         |
-|`RGB_RED`            |`HSV_RED`            |
-|`RGB_SPRINGGREEN`    |`HSV_SPRINGGREEN`    |
-|`RGB_TEAL`           |`HSV_TEAL`           |
-|`RGB_TURQUOISE`      |`HSV_TURQUOISE`      |
-|`RGB_WHITE`          |`HSV_WHITE`          |
-|`RGB_YELLOW`         |`HSV_YELLOW`         |
+|RGB                |HSV                |
+|-------------------|-------------------|
+|`RGB_WHITE`        |`HSV_WHITE`        |
+|`RGB_RED`          |`HSV_RED`          |
+|`RGB_CORAL`        |`HSV_CORAL`        |
+|`RGB_ORANGE`       |`HSV_ORANGE`       |
+|`RGB_GOLDENROD`    |`HSV_GOLDENROD`    |
+|`RGB_GOLD`         |`HSV_GOLD`         |
+|`RGB_YELLOW`       |`HSV_YELLOW`       |
+|`RGB_CHARTREUSE`   |`HSV_CHARTREUSE`   |
+|`RGB_GREEN`        |`HSV_GREEN`        |
+|`RGB_SPRINGGREEN`  |`HSV_SPRINGGREEN`  |
+|`RGB_TURQUOISE`    |`HSV_TURQUOISE`    |
+|`RGB_TEAL`         |`HSV_TEAL`         |
+|`RGB_CYAN`         |`HSV_CYAN`         |
+|`RGB_AZURE`        |`HSV_AZURE`        |
+|`RGB_BLUE`         |`HSV_BLUE`         |
+|`RGB_PURPLE`       |`HSV_PURPLE`       |
+|`RGB_MAGENTA`      |`HSV_MAGENTA`      |
+|`RGB_PINK`         |`HSV_PINK`         |
 
-These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/color.h). Feel free to add to this list!
+These are defined in [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h). Feel free to add to this list!
 
 
 ## Additional `config.h` Options :id=additional-configh-options
@@ -599,10 +405,9 @@ These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master
 ```c
 #define RGB_MATRIX_KEYPRESSES // reacts to keypresses
 #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
-#define RGB_MATRIX_FRAMEBUFFER_EFFECTS // enable framebuffer effects
 #define RGB_DISABLE_TIMEOUT 0 // number of milliseconds to wait until rgb automatically turns off
 #define RGB_DISABLE_AFTER_TIMEOUT 0 // OBSOLETE: number of ticks to wait until disabling effects
-#define RGB_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
+#define RGB_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended
 #define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
 #define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
 #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200 // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255
@@ -612,13 +417,11 @@ These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master
 #define RGB_MATRIX_STARTUP_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set
 #define RGB_MATRIX_STARTUP_SPD 127 // Sets the default animation speed, if none has been set
 #define RGB_MATRIX_DISABLE_KEYCODES // disables control of rgb matrix by keycodes (must use code functions to control the feature)
-#define RGB_MATRIX_SPLIT { X, Y } 	// (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
-                              		// If RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
 ```
 
 ## EEPROM storage :id=eeprom-storage
 
-The EEPROM for it is currently shared with the LED Matrix system (it's generally assumed only one feature would be used at a time), but could be configured to use its own 32bit address with:
+The EEPROM for it is currently shared with the RGBLIGHT system (it's generally assumed only one RGB would be used at a time), but could be configured to use its own 32bit address with:
 
 ```c
 #define EECONFIG_RGB_MATRIX (uint32_t *)28
@@ -709,74 +512,29 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
 }
 ```
 
-### Indicator Examples :id=indicator-examples
+### Suspended state :id=suspended-state
+To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file. 
 
-Caps Lock indicator on alphanumeric flagged keys:
-```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
-    if (host_keyboard_led_state().caps_lock) {
-        for (uint8_t i = led_min; i <= led_max; i++) {
-            if (g_led_config.flags[i] & LED_FLAG_KEYLIGHT) {
-                rgb_matrix_set_color(i, RGB_RED);
-            }
-        }
-    }
-}
-```
-
-Layer indicator on all flagged keys:
-```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
-    for (uint8_t i = led_min; i <= led_max; i++) {
-        switch(get_highest_layer(layer_state|default_layer_state)) {
-            case RAISE:
-                rgb_matrix_set_color(i, RGB_BLUE);
-                break;
-            case LOWER:
-                rgb_matrix_set_color(i, RGB_YELLOW);
-                break;
-            default:
-                break;
-        }
-    }
-}
-```
-
-#### Examples :id=indicator-examples
-
-This example sets the modifiers to be a specific color based on the layer state.  You can use a switch case here, instead, if you would like.  This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver).
+Additionally add this to your `<keyboard>.c`:
 
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
-    HSV hsv = {0, 255, 255};
-    
-    if (layer_state_is(layer_state, 2)) {
-        hsv = {130, 255, 255};
-    } else {
-        hsv = {30, 255, 255};
-    }
-    
-    if (hsv.v > rgb_matrix_get_val()) {
-        hsv.v = rgb_matrix_get_val();
-    }
-    RGB rgb = hsv_to_rgb(hsv);
-    
-    for (uint8_t i = led_min; i <= led_max; i++) {
-        if (HAS_FLAGS(g_led_config.flags[i], 0x01)) { // 0x01 == LED_FLAG_MODIFIER
-            rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);
-        }
-    }
+void suspend_power_down_kb(void) {
+    rgb_matrix_set_suspend_state(true);
+    suspend_power_down_user();
+}
+
+void suspend_wakeup_init_kb(void) {
+    rgb_matrix_set_suspend_state(false);
+    suspend_wakeup_init_user();
 }
 ```
-
-If you want to indicate a Host LED status (caps lock, num lock, etc), you can use something like this to light up the caps lock key: 
-
+or add this to your `keymap.c`:
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
-    if (host_keyboard_led_state().caps_lock) {
-        RGB_MATRIX_INDICATOR_SET_COLOR(5, 255, 255, 255); // assuming caps lock is at led #5
-    } else {
-        RGB_MATRIX_INDICATOR_SET_COLOR(5, 0, 0, 0);
-    }
+void suspend_power_down_user(void) {
+    rgb_matrix_set_suspend_state(true);
+}
+
+void suspend_wakeup_init_user(void) {
+    rgb_matrix_set_suspend_state(false);
 }
 ```

docs/feature_rgblight.md

@@ -10,7 +10,6 @@ Currently QMK supports the following addressable LEDs (however, the white LED in
 
  * WS2811, WS2812, WS2812B, WS2812C, etc.
  * SK6812, SK6812MINI, SK6805
- * APA102
 
 These LEDs are called "addressable" because instead of using a wire per color, each LED contains a small microchip that understands a special protocol sent over a single wire. The chip passes on the remaining data to the next LED, allowing them to be chained together. In this way, you can easily control the color of the individual LEDs.
 
@@ -22,19 +21,11 @@ On keyboards with onboard RGB LEDs, it is usually enabled by default. If it is n
 RGBLIGHT_ENABLE = yes
 ```
 
-For APA102 LEDs, add the following to your `rules.mk`:
-
-```make
-RGBLIGHT_ENABLE = yes
-RGBLIGHT_DRIVER = APA102
-```
-
-At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. For APA102 LEDs, you must also define the clock pin. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these.
+At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these.
 
 |Define         |Description                                                                                              |
 |---------------|---------------------------------------------------------------------------------------------------------|
 |`RGB_DI_PIN`   |The pin connected to the data pin of the LEDs                                                            |
-|`RGB_CI_PIN`   |The pin connected to the clock pin of the LEDs (APA102 only)                                             |
 |`RGBLED_NUM`   |The number of LEDs connected                                                                             |
 |`RGBLED_SPLIT` |(Optional) For split keyboards, the number of LEDs connected on each half directly wired to `RGB_DI_PIN` |
 
@@ -74,7 +65,6 @@ Changing the **Value** sets the overall brightness.<br>
 |`RGB_MODE_XMAS`    |`RGB_M_X` |Christmas animation mode                                            |
 |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode                                      |
 |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode                                |
-|`RGB_MODE_TWINKLE` |`RGB_M_TW`|Twinkle animation mode                                              |
 
 !> By default, if you have both the RGB Light and the [RGB Matrix](feature_rgb_matrix.md) feature enabled, these keycodes will work for both features, at the same time. You can disable the keycode functionality by defining the `*_DISABLE_KEYCODES` option for the specific feature.
 
@@ -83,20 +73,15 @@ Changing the **Value** sets the overall brightness.<br>
 
 Your RGB lighting can be configured by placing these `#define`s in your `config.h`:
 
-|Define                     |Default                     |Description                                                                                                                |
-|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|
-|`RGBLIGHT_HUE_STEP`        |`10`                        |The number of steps to cycle through the hue by                                                                            |
-|`RGBLIGHT_SAT_STEP`        |`17`                        |The number of steps to increment the saturation by                                                                         |
-|`RGBLIGHT_VAL_STEP`        |`17`                        |The number of steps to increment the brightness by                                                                         |
-|`RGBLIGHT_LIMIT_VAL`       |`255`                       |The maximum brightness level                                                                                               |
-|`RGBLIGHT_SLEEP`           |*Not defined*               |If defined, the RGB lighting will be switched off when the host goes to sleep                                              |
-|`RGBLIGHT_SPLIT`           |*Not defined*               |If defined, synchronization functionality for split keyboards is added                                                     |
-|`RGBLIGHT_DISABLE_KEYCODES`|*Not defined*               |If defined, disables the ability to control RGB Light from the keycodes. You must use code functions to control the feature|
-|`RGBLIGHT_DEFAULT_MODE`    |`RGBLIGHT_MODE_STATIC_LIGHT`|The default mode to use upon clearing the EEPROM                                                                           |
-|`RGBLIGHT_DEFAULT_HUE`     |`0` (red)                   |The default hue to use upon clearing the EEPROM                                                                            |
-|`RGBLIGHT_DEFAULT_SAT`     |`UINT8_MAX` (255)           |The default saturation to use upon clearing the EEPROM                                                                     |
-|`RGBLIGHT_DEFAULT_VAL`     |`RGBLIGHT_LIMIT_VAL`        |The default value (brightness) to use upon clearing the EEPROM                                                             |
-|`RGBLIGHT_DEFAULT_SPD`     |`0`                         |The default speed to use upon clearing the EEPROM                                                                          |
+|Define               |Default      |Description                                                                  |
+|---------------------|-------------|-----------------------------------------------------------------------------|
+|`RGBLIGHT_HUE_STEP`  |`10`         |The number of steps to cycle through the hue by                              |
+|`RGBLIGHT_SAT_STEP`  |`17`         |The number of steps to increment the saturation by                           |
+|`RGBLIGHT_VAL_STEP`  |`17`         |The number of steps to increment the brightness by                           |
+|`RGBLIGHT_LIMIT_VAL` |`255`        |The maximum brightness level                                                 |
+|`RGBLIGHT_SLEEP`     |*Not defined*|If defined, the RGB lighting will be switched off when the host goes to sleep|
+|`RGBLIGHT_SPLIT`     |*Not defined*|If defined, synchronization functionality for split keyboards is added|
+|`RGBLIGHT_DISABLE_KEYCODES`|*not defined*|If defined, disables the ability to control RGB Light from the keycodes. You must use code functions to control the feature| 
 
 ## Effects and Animations
 
@@ -119,7 +104,7 @@ if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a n
 
 Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration.
 
-Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight/rgblight.h` there is a contrast table between the old mode number and the current symbol.
+Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight.h` there is a contrast table between the old mode number and the current symbol.
 
 ### Effect and Animation Toggles
 
@@ -154,7 +139,7 @@ The following options are used to tweak the various animations:
 |`RGBLIGHT_EFFECT_KNIGHT_OFFSET`     |`0`          |The number of LEDs to start the "Knight" animation from the start of the strip by              |
 |`RGBLIGHT_RAINBOW_SWIRL_RANGE`      |`255`        |Range adjustment for the rainbow swirl effect to get different swirls                          |
 |`RGBLIGHT_EFFECT_SNAKE_LENGTH`      |`4`          |The number of LEDs to light up for the "Snake" animation                                       |
-|`RGBLIGHT_EFFECT_TWINKLE_LIFE`      |`200`        |Adjusts how quickly each LED brightens and dims when twinkling (in animation steps)            |
+|`RGBLIGHT_EFFECT_TWINKLE_LIFE`      |`75`         |Adjusts how quickly each LED brightens and dims when twinkling (in animation steps)            |
 |`RGBLIGHT_EFFECT_TWINKLE_PROBABILITY`|`1/127`     |Adjusts how likely each LED is to twinkle (on each animation step)                             |
 
 ### Example Usage to Reduce Memory Footprint
@@ -310,29 +295,13 @@ void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
 }
 ```
 
-You can also use `rgblight_blink_layer_repeat` to specify the amount of times the layer is supposed to blink. Using the layers from above,
-```c
-void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
-    switch (keycode) {
-        case DEBUG:
-            rgblight_blink_layer_repeat(debug_enable ? 0 : 1, 200, 3);
-            break;
-    }
-}
-```
-would turn the layer 0 (or 1) on and off again three times when `DEBUG` is pressed.
-
 ### Overriding RGB Lighting on/off status
 
 Normally lighting layers are not shown when RGB Lighting is disabled (e.g. with `RGB_TOG` keycode). If you would like lighting layers to work even when the RGB Lighting is otherwise off, add `#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF` to your `config.h`.
 
-### Retain brightness
-
-Usually lighting layers apply their configured brightness once activated. If you would like lighting layers to retain the currently used brightness (as returned by `rgblight_get_val()`), add `#define RGBLIGHT_LAYERS_RETAIN_VAL` to your `config.h`.
-
 ## Functions
 
-If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight/rgblight.h) for the full list, but the most commonly used functions include:
+If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight.h) for the full list, but the most commonly used functions include:
 
 ### Utility Functions
 |Function                                    |Description                                                        |
@@ -376,9 +345,9 @@ rgblight_set(); // Utility functions do not call rgblight_set() automatically, s
 
 Example:
 ```c
-rgblight_sethsv_at(HSV_WHITE, 0); // led 0
-rgblight_sethsv_at(HSV_RED,   1); // led 1
-rgblight_sethsv_at(HSV_GREEN, 2); // led 2
+rgblight_sethsv(HSV_WHITE, 0); // led 0
+rgblight_sethsv(HSV_RED,   1); // led 1
+rgblight_sethsv(HSV_GREEN, 2); // led 2
 // The above functions automatically calls rgblight_set(), so there is no need to call it explicitly.
 // Note that it is inefficient to call repeatedly.
 ```
@@ -453,27 +422,26 @@ rgblight_sethsv_at(HSV_GREEN, 2); // led 2
 
 These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions.
 
-|RGB                  |HSV                  |
-|---------------------|---------------------|
-|`RGB_AZURE`          |`HSV_AZURE`          |
-|`RGB_BLACK`/`RGB_OFF`|`HSV_BLACK`/`HSV_OFF`|
-|`RGB_BLUE`           |`HSV_BLUE`           |
-|`RGB_CHARTREUSE`     |`HSV_CHARTREUSE`     |
-|`RGB_CORAL`          |`HSV_CORAL`          |
-|`RGB_CYAN`           |`HSV_CYAN`           |
-|`RGB_GOLD`           |`HSV_GOLD`           |
-|`RGB_GOLDENROD`      |`HSV_GOLDENROD`      |
-|`RGB_GREEN`          |`HSV_GREEN`          |
-|`RGB_MAGENTA`        |`HSV_MAGENTA`        |
-|`RGB_ORANGE`         |`HSV_ORANGE`         |
-|`RGB_PINK`           |`HSV_PINK`           |
-|`RGB_PURPLE`         |`HSV_PURPLE`         |
-|`RGB_RED`            |`HSV_RED`            |
-|`RGB_SPRINGGREEN`    |`HSV_SPRINGGREEN`    |
-|`RGB_TEAL`           |`HSV_TEAL`           |
-|`RGB_TURQUOISE`      |`HSV_TURQUOISE`      |
-|`RGB_WHITE`          |`HSV_WHITE`          |
-|`RGB_YELLOW`         |`HSV_YELLOW`         |
+|RGB                |HSV                |
+|-------------------|-------------------|
+|`RGB_WHITE`        |`HSV_WHITE`        |
+|`RGB_RED`          |`HSV_RED`          |
+|`RGB_CORAL`        |`HSV_CORAL`        |
+|`RGB_ORANGE`       |`HSV_ORANGE`       |
+|`RGB_GOLDENROD`    |`HSV_GOLDENROD`    |
+|`RGB_GOLD`         |`HSV_GOLD`         |
+|`RGB_YELLOW`       |`HSV_YELLOW`       |
+|`RGB_CHARTREUSE`   |`HSV_CHARTREUSE`   |
+|`RGB_GREEN`        |`HSV_GREEN`        |
+|`RGB_SPRINGGREEN`  |`HSV_SPRINGGREEN`  |
+|`RGB_TURQUOISE`    |`HSV_TURQUOISE`    |
+|`RGB_TEAL`         |`HSV_TEAL`         |
+|`RGB_CYAN`         |`HSV_CYAN`         |
+|`RGB_AZURE`        |`HSV_AZURE`        |
+|`RGB_BLUE`         |`HSV_BLUE`         |
+|`RGB_PURPLE`       |`HSV_PURPLE`       |
+|`RGB_MAGENTA`      |`HSV_MAGENTA`      |
+|`RGB_PINK`         |`HSV_PINK`         |
 
 ```c
 rgblight_setrgb(RGB_ORANGE);
@@ -482,7 +450,7 @@ rgblight_setrgb_at(RGB_GOLD, 3);
 rgblight_sethsv_range(HSV_WHITE, 0, 6);
 ```
 
-These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/color.h). Feel free to add to this list!
+These are defined in [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h). Feel free to add to this list!
 
 
 ## Changing the order of the LEDs

docs/feature_split_keyboard.md

@@ -8,7 +8,8 @@ QMK Firmware has a generic implementation that is usable by any board, as well a
 
 For this, we will mostly be talking about the generic implementation used by the Let's Split and other keyboards. 
 
-!> ARM split supports most QMK subsystems when using the 'serial' and 'serial_usart' drivers. I2C slave is currently unsupported.
+!> ARM is not yet fully supported for Split Keyboards and has many limitations. Progress is being made, but we have not yet reached 100% feature parity.
+
 
 ## Compatibility Overview
 
@@ -59,7 +60,6 @@ The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and D0/D1/D2/D3 (aka
 The 4 wires of the TRRS cable need to connect GND, VCC, and SCL and SDA (aka PD0/pin 3 and PD1/pin 2, respectively) between the two Pro Micros. 
 
 The pull-up resistors may be placed on either half. If you wish to use the halves independently, it is also possible to use 4 resistors and have the pull-ups in both halves.
-Note that the total resistance for the connected system should be within spec at 2.2k-10kOhm, with an 'ideal' at 4.7kOhm, regardless of the placement and number.
 
 <img alt="sk-i2c-connection-mono" src="https://user-images.githubusercontent.com/2170248/92297182-92b98580-ef77-11ea-9d7d-d6033914af43.JPG" width="50%"/>
 
@@ -89,13 +89,7 @@ You can configure the firmware to read a pin on the controller to determine hand
 #define SPLIT_HAND_PIN B7
 ```
 
-This will read the specified pin. By default, if it's high, then the controller assumes it is the left hand, and if it's low, it's assumed to be the right side. 
-
-This behaviour can be flipped by adding this to you `config.h` file:
-
-```c
-#define	SPLIT_HAND_PIN_LOW_IS_LEFT
-```
+This will read the specified pin. If it's high, then the controller assumes it is the left hand, and if it's low, it's assumed to be the right side. 
 
 #### Handedness by Matrix Pin
 
@@ -115,10 +109,6 @@ Normally, when a diode is connected to an intersection, it is judged to be left.
 #define SPLIT_HAND_MATRIX_GRID_LOW_IS_RIGHT
 ```
 
-Note that adding a diode at a previously unused intersection will effectively tell the firmware that there is a key held down at that point. You can instruct qmk to ignore that intersection by defining `MATRIX_MASKED` and then defining a `matrix_row_t matrix_mask[MATRIX_ROWS]` array in your keyboard config. Each bit of a single value (starting form the least-significant bit) is used to tell qmk whether or not to pay attention to key presses at that intersection.
-
-While `MATRIX_MASKED` isn't necessary to use `SPLIT_HAND_MATRIX_GRID` successfully, without it you may experience issues trying to suspend your computer with your keyboard attached as the matrix will always report at least one key-press.
-
 #### Handedness by EEPROM
 
 This method sets the keyboard's handedness by setting a flag in the persistent storage (`EEPROM`).  This is checked when the controller first starts up, and determines what half the keyboard is, and how to orient the keyboard layout. 
@@ -139,12 +129,6 @@ However, you'll have to flash the EEPROM files for the correct hand to each cont
 * `:dfu-util-split-left`
 * `:dfu-util-split-right`
 
-Example:
-
-```
-make crkbd:default:avrdude-split-left
-```
-
 This setting is not changed when re-initializing the EEPROM using the `EEP_RST` key, or using the `eeconfig_init()` function.  However, if you reset the EEPROM outside of the firmware's built in options (such as flashing a file that overwrites the `EEPROM`, like how the [QMK Toolbox]()'s "Reset EEPROM" button works), you'll need to re-flash the controller with the `EEPROM` files. 
 
 You can find the `EEPROM` files in the QMK firmware repo, [here](https://github.com/qmk/qmk_firmware/tree/master/quantum/split_common). 
@@ -174,7 +158,7 @@ Because not every split keyboard is identical, there are a number of additional
 #define USE_I2C
 ```
 
-This configures the use of I<sup>2</sup>C support for split keyboard transport (AVR only).  
+This enables I<sup>2</sup>C support for split keyboards. This isn't strictly for communication, but can be used for OLED or other I<sup>2</sup>C-based devices. 
 
 ```c
 #define SOFT_SERIAL_PIN D0
@@ -197,145 +181,6 @@ If you're having issues with serial communication, you can change this value, as
 * **`4`**: about 26kbps
 * **`5`**: about 20kbps
 
-```c
-#define FORCED_SYNC_THROTTLE_MS 100
-```
-
-This sets the maximum number of milliseconds before forcing a synchronization of data from master to slave. Under normal circumstances this sync occurs whenever the data _changes_, for safety a data transfer occurs after this number of milliseconds if no change has been detected since the last sync. 
-
-```c
-#define SPLIT_MAX_CONNECTION_ERRORS 10
-```
-This sets the maximum number of failed communication attempts (one per scan cycle) from the master part before it assumes that no slave part is connected. This makes it possible to use a master part without the slave part connected.
-
-Set to 0 to disable the disconnection check altogether.
-
-```c
-#define SPLIT_CONNECTION_CHECK_TIMEOUT 500
-```
-How long (in milliseconds) the master part should block all connection attempts to the slave after the communication has been flagged as disconnected (see `SPLIT_MAX_CONNECTION_ERRORS` above).
-
-One communication attempt will be allowed everytime this amount of time has passed since the last attempt. If that attempt succeeds, the communication is seen as working again.
-
-Set to 0 to disable this throttling of communications while disconnected. This can save you a couple of bytes of firmware size.
-
-```c
-#define SPLIT_TRANSPORT_MIRROR
-```
-
-This mirrors the master side matrix to the slave side for features that react or require knowledge of master side key presses on the slave side. The purpose of this feature is to support cosmetic use of key events (e.g. RGB reacting to keypresses). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 
-
-```c
-#define SPLIT_LAYER_STATE_ENABLE
-```
-
-This enables syncing of the layer state between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the currently active layer. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 
-
-```c
-#define SPLIT_LED_STATE_ENABLE
-```
-
-This enables syncing of the Host LED status (caps lock, num lock, etc) between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the Host LED status. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 
-
-```c
-#define SPLIT_MODS_ENABLE
-```
-
-This enables transmitting modifier state (normal, weak and oneshot) to the non primary side of the split keyboard. The purpose of this feature is to support cosmetic use of modifer state (e.g. displaying status on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 
-
-```c
-#define SPLIT_WPM_ENABLE
-```
-
-This enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 
-
-```c
-#define SPLIT_OLED_ENABLE
-```
-
-This enables transmitting the current OLED on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 
-
-```c
-#define SPLIT_ST7565_ENABLE
-```
-
-This enables transmitting the current ST7565 on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. 
-
-### Custom data sync between sides :id=custom-data-sync
-
-QMK's split transport allows for arbitrary data transactions at both the keyboard and user levels. This is modelled on a remote procedure call, with the master invoking a function on the slave side, with the ability to send data from master to slave, process it slave side, and send data back from slave to master.
-
-To leverage this, a keyboard or user/keymap can define a comma-separated list of _transaction IDs_:
-
-```c
-// for keyboard-level data sync:
-#define SPLIT_TRANSACTION_IDS_KB KEYBOARD_SYNC_A, KEYBOARD_SYNC_B
-// or, for user:
-#define SPLIT_TRANSACTION_IDS_USER USER_SYNC_A, USER_SYNC_B, USER_SYNC_C
-```
-
-These _transaction IDs_ then need a slave-side handler function to be registered with the split transport, for example:
-
-```c
-typedef struct _master_to_slave_t {
-    int m2s_data;
-} master_to_slave_t;
-
-typedef struct _slave_to_master_t {
-    int s2m_data;
-} slave_to_master_t;
-
-void user_sync_a_slave_handler(uint8_t in_buflen, const void* in_data, uint8_t out_buflen, void* out_data) {
-    const master_to_slave_t *m2s = (const master_to_slave_t*)in_data;
-    slave_to_master_t *s2m = (slave_to_master_t*)out_data;
-    s2m->s2m_data = m2s->m2s_data + 5; // whatever comes in, add 5 so it can be sent back
-}
-
-void keyboard_post_init_user(void) {
-    transaction_register_rpc(USER_SYNC_A, user_sync_a_slave_handler);
-}
-```
-
-The master side can then invoke the slave-side handler - for normal keyboard functionality to be minimally affected, any keyboard- or user-level code attempting to sync data should be throttled:
-
-```c
-void housekeeping_task_user(void) {
-    if (is_keyboard_master()) {
-        // Interact with slave every 500ms
-        static uint32_t last_sync = 0;
-        if (timer_elapsed32(last_sync) > 500) {
-            master_to_slave_t m2s = {6};
-            slave_to_master_t s2m = {0};
-            if(transaction_rpc_exec(USER_SYNC_A, sizeof(m2s), &m2s, sizeof(s2m), &s2m)) {
-                last_sync = timer_read32();
-                dprintf("Slave value: %d\n", s2m.s2m_data); // this will now be 11, as the slave adds 5
-            } else {
-                dprint("Slave sync failed!\n");
-            }
-        }
-    }
-}
-```
-
-!> It is recommended that any data sync between halves happens during the master side's _housekeeping task_. This ensures timely retries should failures occur.
-
-If only one-way data transfer is needed, helper methods are provided:
-
-```c
-bool transaction_rpc_exec(int8_t transaction_id, uint8_t initiator2target_buffer_size, const void *initiator2target_buffer, uint8_t target2initiator_buffer_size, void *target2initiator_buffer);
-bool transaction_rpc_send(int8_t transaction_id, uint8_t initiator2target_buffer_size, const void *initiator2target_buffer);
-bool transaction_rpc_recv(int8_t transaction_id, uint8_t target2initiator_buffer_size, void *target2initiator_buffer);
-```
-
-By default, the inbound and outbound data is limited to a maximum of 32 bytes each. The sizes can be altered if required:
-
-```c
-// Master to slave:
-#define RPC_M2S_BUFFER_SIZE 48
-// Slave to master:
-#define RPC_S2M_BUFFER_SIZE 48
-```
-
 ###  Hardware Configuration Options
 
 There are some settings that you may need to configure, based on how the hardware is set up. 
@@ -378,12 +223,7 @@ This sets how many LEDs are directly connected to each controller.  The first nu
 ```c
 #define SPLIT_USB_DETECT
 ```
-
-Enabling this option changes the startup behavior to listen for an active USB communication to delegate which part is master and which is slave. With this option enabled and theres's USB communication, then that half assumes it is the master, otherwise it assumes it is the slave.
-
-Without this option, the master is the half that can detect voltage on the physical USB connection (VBUS detection).
-
-Enabled by default on ChibiOS/ARM.
+This option changes the startup behavior to detect an active USB connection when delegating master/slave. If this operation times out, then the half is assume to be a slave. This is the default behavior for ARM, and required for AVR Teensy boards (due to hardware limitations).
 
 ?> This setting will stop the ability to demo using battery packs.
 
@@ -399,13 +239,9 @@ This sets the poll frequency when detecting master/slave when using `SPLIT_USB_D
 
 ## Hardware Considerations and Mods
 
-Master/slave delegation is made either by detecting voltage on VBUS connection or waiting for USB communication (`SPLIT_USB_DETECT`). Pro Micro boards can use VBUS detection out of the box and be used with or without `SPLIT_USB_DETECT`.
+While most any Pro Micro can be used, micro controllers like the AVR Teensys and most (if not all) ARM boards require the Split USB Detect.
 
-Many ARM boards, but not all, do not support VBUS detection. Because it is common that ARM boards lack VBUS detection, `SPLIT_USB_DETECT` is automatically defined on ARM targets (technically when ChibiOS is targetted).
-
-### Teensy boards
-
-Teensy boards lack VBUS detection out of the box and must have `SPLIT_USB_DETECT` defined. With the Teensy 2.0 and Teensy++ 2.0, there is a simple hardware mod that you can perform to add VBUS detection, so you don't need the `SPLIT_USB_DETECT` option.
+However, with the Teensy 2.0 and Teensy++ 2.0, there is a simple hardware mod that you can perform to add VBUS detection, so you don't need the Split USB detection option.
 
 You'll only need a few things:
 

docs/feature_st7565.md

@@ -1,274 +0,0 @@
-# ST7565 LCD Driver
-
-## Supported Hardware
-
-LCD modules using ST7565 driver IC, communicating over SPI.
-
-|Module                        |IC     |Size  |Notes                                                     |
-|------------------------------|-------|------|----------------------------------------------------------|
-|Newhaven Display NHD-C12832A1Z|ST7565R|128x32|Used by Ergodox Infinity; primary consumer of this feature|
-|Zolentech ZLE12864B           |ST7565P|128x64|Requires contrast adjustment                              |
-
-## Usage
-
-To enable the feature, there are three steps. First, when compiling your keyboard, you'll need to add the following to your `rules.mk`:
-
-```make
-ST7565_ENABLE = yes
-```
-
-Then in your `keymap.c` file, implement the ST7565 task call. This example assumes your keymap has three layers named `_QWERTY`, `_FN` and `_ADJ`:
-
-```c
-#ifdef ST7565_ENABLE
-void st7565_task_user(void) {
-    // Host Keyboard Layer Status
-    st7565_write_P(PSTR("Layer: "), false);
-
-    switch (get_highest_layer(layer_state)) {
-        case _QWERTY:
-            st7565_write_P(PSTR("Default\n"), false);
-            break;
-        case _FN:
-            st7565_write_P(PSTR("FN\n"), false);
-            break;
-        case _ADJ:
-            st7565_write_P(PSTR("ADJ\n"), false);
-            break;
-        default:
-            // Or use the write_ln shortcut over adding '\n' to the end of your string
-            st7565_write_ln_P(PSTR("Undefined"), false);
-    }
-
-    // Host Keyboard LED Status
-    led_t led_state = host_keyboard_led_state();
-    st7565_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR("    "), false);
-    st7565_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR("    "), false);
-    st7565_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR("    "), false);
-}
-#endif
-```
-
-## Logo Example
-
-In the default font, certain ranges of characters are reserved for a QMK logo. To render this logo to the screen, use the following code example:
-
-```c
-static void render_logo(void) {
-    static const char PROGMEM qmk_logo[] = {
-        0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F, 0x90, 0x91, 0x92, 0x93, 0x94,
-        0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF, 0xB0, 0xB1, 0xB2, 0xB3, 0xB4,
-        0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF, 0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0x00
-    };
-
-    st7565_write_P(qmk_logo, false);
-}
-```
-
-## Buffer Read Example
-For some purposes, you may need to read the current state of the display buffer. The `st7565_read_raw` function can be used to safely read bytes from the buffer.
-
-In this example, calling `fade_display` in the `st7565_task_user` function will slowly fade away whatever is on the screen by turning random pixels off over time.
-```c
-//Setup some mask which can be or'd with bytes to turn off pixels
-const uint8_t single_bit_masks[8] = {127, 191, 223, 239, 247, 251, 253, 254};
-
-static void fade_display(void) {
-    //Define the reader structure
-    display_buffer_reader_t reader;
-    uint8_t buff_char;
-    if (random() % 30 == 0) {
-        srand(timer_read());
-        // Fetch a pointer for the buffer byte at index 0. The return structure
-        // will have the pointer and the number of bytes remaining from this
-        // index position if we want to perform a sequential read by
-        // incrementing the buffer pointer
-        reader = st7565_read_raw(0);
-        //Loop over the remaining buffer and erase pixels as we go
-        for (uint16_t i = 0; i < reader.remaining_element_count; i++) {
-            //Get the actual byte in the buffer by dereferencing the pointer
-            buff_char = *reader.current_element;
-            if (buff_char != 0) {
-                st7565_write_raw_byte(buff_char & single_bit_masks[rand() % 8], i);
-            }
-            //increment the pointer to fetch a new byte during the next loop
-            reader.current_element++;
-        }
-    }
-}
-```
-
-## Other Examples
-
-In split keyboards, it is very common to have two displays that each render different content and are oriented or flipped differently. You can do this by switching which content to render by using the return value from `is_keyboard_master()` or `is_keyboard_left()` found in `split_util.h`, e.g:
-
-```c
-#ifdef ST7565_ENABLE
-display_rotation_t st7565_init_user(display_rotation_t rotation) {
-    if (!is_keyboard_master()) {
-        return DISPLAY_ROTATION_180;  // flips the display 180 degrees if offhand
-    }
-
-    return rotation;
-}
-
-void st7565_task_user(void) {
-    if (is_keyboard_master()) {
-        render_status();  // Renders the current keyboard state (layer, lock, caps, scroll, etc)
-    } else {
-        render_logo();  // Renders a static logo
-    }
-}
-#endif
-```
-
-## Basic Configuration
-
-|Define                  |Default       |Description                                                                                          |
-|------------------------|--------------|-----------------------------------------------------------------------------------------------------|
-|`ST7565_A0_PIN`         |*Not defined* |(Required) The GPIO connected to the display's A0 (data/command) pin                                 |
-|`ST7565_RST_PIN`        |*Not defined* |(Required) The GPIO connected to the display's reset pin                                             |
-|`ST7565_SS_PIN`         |*Not defined* |(Required) The GPIO connected to the display's slave select pin                                      |
-|`ST7565_SPI_CLK_DIVISOR`|`4`           |The SPI clock divisor to use                                                                         |
-|`ST7565_FONT_H`         |`"glcdfont.c"`|The font code file to use for custom fonts                                                           |
-|`ST7565_FONT_START`     |`0`           |The starting character index for custom fonts                                                        |
-|`ST7565_FONT_END`       |`223`         |The ending character index for custom fonts                                                          |
-|`ST7565_FONT_WIDTH`     |`6`           |The font width                                                                                       |
-|`ST7565_FONT_HEIGHT`    |`8`           |The font height (untested)                                                                           |
-|`ST7565_TIMEOUT`        |`60000`       |Turns off the screen after 60000ms of keyboard inactivity. Helps reduce burn-in. Set to 0 to disable.|
-|`ST7565_COLUMN_OFFSET`  |`0`           |Shift output to the right this many pixels.                                                          |
-|`ST7565_CONTRAST`       |`32`          |The default contrast level of the display, from 0 to 255.                                            |
-|`ST7565_UPDATE_INTERVAL`|`0`           |Set the time interval for updating the display in ms. This will improve the matrix scan rate.        |
-
-## Custom sized displays
-
-The default display size for this feature is 128x32 and all necessary defines are precalculated with that in mind.
-
-|Define                 |Default   |Description                                                                                                |
-|-----------------------|----------|-----------------------------------------------------------------------------------------------------------|
-|`ST7565_DISPLAY_WIDTH` |`128`     |The width of the display.                                                                                  |
-|`ST7565_DISPLAY_HEIGHT`|`32`      |The height of the display.                                                                                 |
-|`ST7565_MATRIX_SIZE`   |`512`     |The local buffer size to allocate.<br>`(ST7565_DISPLAY_HEIGHT / 8 * ST7565_DISPLAY_WIDTH)`.                |
-|`ST7565_BLOCK_TYPE`    |`uint16_t`|The unsigned integer type to use for dirty rendering.                                                      |
-|`ST7565_BLOCK_COUNT`   |`16`      |The number of blocks the display is divided into for dirty rendering.<br>`(sizeof(ST7565_BLOCK_TYPE) * 8)`.|
-|`ST7565_BLOCK_SIZE`    |`32`      |The size of each block for dirty rendering<br>`(ST7565_MATRIX_SIZE / ST7565_BLOCK_COUNT)`.                 |
-
-## API
-
-```c
-// Rotation enum values are flags
-typedef enum {
-    DISPLAY_ROTATION_0,
-    DISPLAY_ROTATION_180
-} display_rotation_t;
-
-// Initialize the display, rotating the rendered output based on the define passed in.
-// Returns true if the was initialized successfully
-bool st7565_init(display_rotation_t rotation);
-
-// Called at the start of st7565_init, weak function overridable by the user
-// rotation - the value passed into st7565_init
-// Return new display_rotation_t if you want to override default rotation
-display_rotation_t st7565_init_user(display_rotation_t rotation);
-
-// Clears the display buffer, resets cursor position to 0, and sets the buffer to dirty for rendering
-void st7565_clear(void);
-
-// Renders the dirty chunks of the buffer to display
-void st7565_render(void);
-
-// Moves cursor to character position indicated by column and line, wraps if out of bounds
-// Max column denoted by 'st7565_max_chars()' and max lines by 'st7565_max_lines()' functions
-void st7565_set_cursor(uint8_t col, uint8_t line);
-
-// Advances the cursor to the next page, writing ' ' if true
-// Wraps to the begining when out of bounds
-void st7565_advance_page(bool clearPageRemainder);
-
-// Moves the cursor forward 1 character length
-// Advance page if there is not enough room for the next character
-// Wraps to the begining when out of bounds
-void st7565_advance_char(void);
-
-// Writes a single character to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-// Main handler that writes character data to the display buffer
-void st7565_write_char(const char data, bool invert);
-
-// Writes a string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-void st7565_write(const char *data, bool invert);
-
-// Writes a string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-// Advances the cursor to the next page, wiring ' ' to the remainder of the current page
-void st7565_write_ln(const char *data, bool invert);
-
-// Pans the buffer to the right (or left by passing true) by moving contents of the buffer
-// Useful for moving the screen in preparation for new drawing
-void st7565_pan(bool left);
-
-// Returns a pointer to the requested start index in the buffer plus remaining
-// buffer length as struct
-display_buffer_reader_t st7565_read_raw(uint16_t start_index);
-
-// Writes a string to the buffer at current cursor position
-void st7565_write_raw(const char *data, uint16_t size);
-
-// Writes a single byte into the buffer at the specified index
-void st7565_write_raw_byte(const char data, uint16_t index);
-
-// Sets a specific pixel on or off
-// Coordinates start at top-left and go right and down for positive x and y
-void st7565_write_pixel(uint8_t x, uint8_t y, bool on);
-
-// Writes a PROGMEM string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-// Remapped to call 'void st7565_write(const char *data, bool invert);' on ARM
-void st7565_write_P(const char *data, bool invert);
-
-// Writes a PROGMEM string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-// Advances the cursor to the next page, wiring ' ' to the remainder of the current page
-// Remapped to call 'void st7565_write_ln(const char *data, bool invert);' on ARM
-void st7565_write_ln_P(const char *data, bool invert);
-
-// Writes a PROGMEM string to the buffer at current cursor position
-void st7565_write_raw_P(const char *data, uint16_t size);
-
-// Can be used to manually turn on the screen if it is off
-// Returns true if the screen was on or turns on
-bool st7565_on(void);
-
-// Called when st7565_on() turns on the screen, weak function overridable by the user
-// Not called if the screen is already on
-void st7565_on_user(void);
-
-// Can be used to manually turn off the screen if it is on
-// Returns true if the screen was off or turns off
-bool st7565_off(void);
-
-// Called when st7565_off() turns off the screen, weak function overridable by the user
-// Not called if the screen is already off
-void st7565_off_user(void);
-
-// Returns true if the screen is currently on, false if it is
-// not
-bool st7565_is_on(void);
-
-// Basically it's st7565_render, but with timeout management and st7565_task_user calling!
-void st7565_task(void);
-
-// Called at the start of st7565_task, weak function overridable by the user
-void st7565_task_user(void);
-
-// Inverts the display
-// Returns true if the screen was or is inverted
-bool st7565_invert(bool invert);
-
-// Returns the maximum number of characters that will fit on a line
-uint8_t st7565_max_chars(void);
-
-// Returns the maximum number of lines that will fit on the display
-uint8_t st7565_max_lines(void);
-```

docs/feature_stenography.md

@@ -128,18 +128,3 @@ As defined in `keymap_steno.h`.
 |`STN_RES1`||(GeminiPR only)|
 |`STN_RES2`||(GeminiPR only)|
 |`STN_PWR`||(GeminiPR only)|
-
-If you do not want to hit two keys with one finger combined keycodes can be used. These are also defined in `keymap_steno.h`, and causes both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file 
-|Combined key   | Key1   | Key 2    |
-|---------------|--------|----------|
-|STN_S3         | STN_S1 | STN_S2   |
-|STN_TKL        | STN_TL | STN_KL   |
-|STN_PWL        | STN_PL | STN_WL   |
-|STN_HRL        | STN_HL | STN_RL   |
-|STN_FRR        | STN_FR | STN_RR   |
-|STN_PBR        | STN_PR | STN_BR   |
-|STN_LGR        | STN_LR | STN_GR   |
-|STN_TSR        | STN_TR | STN_SR   |
-|STN_DZR        | STN_DR | STN_ZR   |
-|STN_AO         | STN_A  | STN_O    |
-|STN_EU         | STN_E  | STN_U    |

docs/feature_swap_hands.md

@@ -7,7 +7,7 @@ The swap-hands action allows support for one-handed typing without requiring a s
 The configuration table is a simple 2-dimensional array to map from column/row to new column/row. Example `hand_swap_config` for Planck:
 
 ```C
-const keypos_t PROGMEM hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = {
+const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = {
   {{11, 0}, {10, 0}, {9, 0}, {8, 0}, {7, 0}, {6, 0}, {5, 0}, {4, 0}, {3, 0}, {2, 0}, {1, 0}, {0, 0}},
   {{11, 1}, {10, 1}, {9, 1}, {8, 1}, {7, 1}, {6, 1}, {5, 1}, {4, 1}, {3, 1}, {2, 1}, {1, 1}, {0, 1}},
   {{11, 2}, {10, 2}, {9, 2}, {8, 2}, {7, 2}, {6, 2}, {5, 2}, {4, 2}, {3, 2}, {2, 2}, {1, 2}, {0, 2}},

docs/feature_tap_dance.md

@@ -50,7 +50,7 @@ The main entry point is `process_tap_dance()`, called from `process_record_quant
 
 This means that you have `TAPPING_TERM` time to tap the key again; you do not have to input all the taps within a single `TAPPING_TERM` timeframe. This allows for longer tap counts, with minimal impact on responsiveness.
 
-Our next stop is `tap_dance_task()`. This handles the timeout of tap-dance keys.
+Our next stop is `matrix_scan_tap_dance()`. This handles the timeout of tap-dance keys.
 
 For the sake of flexibility, tap-dance actions can be either a pair of keycodes, or a user function. The latter allows one to handle higher tap counts, or do extra things, like blink the LEDs, fiddle with the backlighting, and so on. This is accomplished by using an union, and some clever macros.
 
@@ -76,7 +76,7 @@ qk_tap_dance_action_t tap_dance_actions[] = {
     [TD_ESC_CAPS] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS),
 };
 
-// Add tap dance item to your keymap in place of a keycode
+// Add tap dance item in place of a key code
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
     // ...
     TD(TD_ESC_CAPS)
@@ -206,22 +206,20 @@ You will need a few things that can be used for 'Quad Function Tap-Dance'.
 You'll need to add these to the top of your `keymap.c` file, before your keymap. 
 
 ```c
-typedef enum {
-    TD_NONE,
-    TD_UNKNOWN,
-    TD_SINGLE_TAP,
-    TD_SINGLE_HOLD,
-    TD_DOUBLE_TAP,
-    TD_DOUBLE_HOLD,
-    TD_DOUBLE_SINGLE_TAP, // Send two single taps
-    TD_TRIPLE_TAP,
-    TD_TRIPLE_HOLD
-} td_state_t;
-
 typedef struct {
     bool is_press_action;
-    td_state_t state;
-} td_tap_t;
+    uint8_t state;
+} tap;
+
+enum {
+    SINGLE_TAP = 1,
+    SINGLE_HOLD,
+    DOUBLE_TAP,
+    DOUBLE_HOLD,
+    DOUBLE_SINGLE_TAP, // Send two single taps
+    TRIPLE_TAP,
+    TRIPLE_HOLD
+};
 
 // Tap dance enums
 enum {
@@ -229,7 +227,7 @@ enum {
     SOME_OTHER_DANCE
 };
 
-td_state_t cur_dance(qk_tap_dance_state_t *state);
+uint8_t cur_dance(qk_tap_dance_state_t *state);
 
 // For the x tap dance. Put it here so it can be used in any keymap
 void x_finished(qk_tap_dance_state_t *state, void *user_data);
@@ -263,61 +261,61 @@ Now, at the bottom of your `keymap.c` file, you'll need to add the following:
  *  Letters used in common words as a double. For example 'p' in 'pepper'. If a tap dance function existed on the
  *    letter 'p', the word 'pepper' would be quite frustating to type.
  *
- * For the third point, there does exist the 'TD_DOUBLE_SINGLE_TAP', however this is not fully tested
+ * For the third point, there does exist the 'DOUBLE_SINGLE_TAP', however this is not fully tested
  *
  */
-td_state_t cur_dance(qk_tap_dance_state_t *state) {
+uint8_t cur_dance(qk_tap_dance_state_t *state) {
     if (state->count == 1) {
-        if (state->interrupted || !state->pressed) return TD_SINGLE_TAP;
+        if (state->interrupted || !state->pressed) return SINGLE_TAP;
         // Key has not been interrupted, but the key is still held. Means you want to send a 'HOLD'.
-        else return TD_SINGLE_HOLD;
+        else return SINGLE_HOLD;
     } else if (state->count == 2) {
-        // TD_DOUBLE_SINGLE_TAP is to distinguish between typing "pepper", and actually wanting a double tap
+        // DOUBLE_SINGLE_TAP is to distinguish between typing "pepper", and actually wanting a double tap
         // action when hitting 'pp'. Suggested use case for this return value is when you want to send two
         // keystrokes of the key, and not the 'double tap' action/macro.
-        if (state->interrupted) return TD_DOUBLE_SINGLE_TAP;
-        else if (state->pressed) return TD_DOUBLE_HOLD;
-        else return TD_DOUBLE_TAP;
+        if (state->interrupted) return DOUBLE_SINGLE_TAP;
+        else if (state->pressed) return DOUBLE_HOLD;
+        else return DOUBLE_TAP;
     }
 
     // Assumes no one is trying to type the same letter three times (at least not quickly).
     // If your tap dance key is 'KC_W', and you want to type "www." quickly - then you will need to add
-    // an exception here to return a 'TD_TRIPLE_SINGLE_TAP', and define that enum just like 'TD_DOUBLE_SINGLE_TAP'
+    // an exception here to return a 'TRIPLE_SINGLE_TAP', and define that enum just like 'DOUBLE_SINGLE_TAP'
     if (state->count == 3) {
-        if (state->interrupted || !state->pressed) return TD_TRIPLE_TAP;
-        else return TD_TRIPLE_HOLD;
-    } else return TD_UNKNOWN;
+        if (state->interrupted || !state->pressed) return TRIPLE_TAP;
+        else return TRIPLE_HOLD;
+    } else return 8; // Magic number. At some point this method will expand to work for more presses
 }
 
-// Create an instance of 'td_tap_t' for the 'x' tap dance.
-static td_tap_t xtap_state = {
+// Create an instance of 'tap' for the 'x' tap dance.
+static tap xtap_state = {
     .is_press_action = true,
-    .state = TD_NONE
+    .state = 0
 };
 
 void x_finished(qk_tap_dance_state_t *state, void *user_data) {
     xtap_state.state = cur_dance(state);
     switch (xtap_state.state) {
-        case TD_SINGLE_TAP: register_code(KC_X); break;
-        case TD_SINGLE_HOLD: register_code(KC_LCTRL); break;
-        case TD_DOUBLE_TAP: register_code(KC_ESC); break;
-        case TD_DOUBLE_HOLD: register_code(KC_LALT); break;
+        case SINGLE_TAP: register_code(KC_X); break;
+        case SINGLE_HOLD: register_code(KC_LCTRL); break;
+        case DOUBLE_TAP: register_code(KC_ESC); break;
+        case DOUBLE_HOLD: register_code(KC_LALT); break;
         // Last case is for fast typing. Assuming your key is `f`:
         // For example, when typing the word `buffer`, and you want to make sure that you send `ff` and not `Esc`.
         // In order to type `ff` when typing fast, the next character will have to be hit within the `TAPPING_TERM`, which by default is 200ms.
-        case TD_DOUBLE_SINGLE_TAP: tap_code(KC_X); register_code(KC_X);
+        case DOUBLE_SINGLE_TAP: tap_code(KC_X); register_code(KC_X);
     }
 }
 
 void x_reset(qk_tap_dance_state_t *state, void *user_data) {
     switch (xtap_state.state) {
-        case TD_SINGLE_TAP: unregister_code(KC_X); break;
-        case TD_SINGLE_HOLD: unregister_code(KC_LCTRL); break;
-        case TD_DOUBLE_TAP: unregister_code(KC_ESC); break;
-        case TD_DOUBLE_HOLD: unregister_code(KC_LALT);
-        case TD_DOUBLE_SINGLE_TAP: unregister_code(KC_X);
+        case SINGLE_TAP: unregister_code(KC_X); break;
+        case SINGLE_HOLD: unregister_code(KC_LCTRL); break;
+        case DOUBLE_TAP: unregister_code(KC_ESC); break;
+        case DOUBLE_HOLD: unregister_code(KC_LALT);
+        case DOUBLE_SINGLE_TAP: unregister_code(KC_X);
     }
-    xtap_state.state = TD_NONE;
+    xtap_state.state = 0;
 }
 
 qk_tap_dance_action_t tap_dance_actions[] = {
@@ -345,11 +343,9 @@ enum td_keycodes {
 
 // Define a type containing as many tapdance states as you need
 typedef enum {
-    TD_NONE,
-    TD_UNKNOWN,
-    TD_SINGLE_TAP,
-    TD_SINGLE_HOLD,
-    TD_DOUBLE_SINGLE_TAP
+    SINGLE_TAP,
+    SINGLE_HOLD,
+    DOUBLE_SINGLE_TAP
 } td_state_t;
 
 // Create a global instance of the tapdance state type
@@ -358,7 +354,7 @@ static td_state_t td_state;
 // Declare your tapdance functions:
 
 // Function to determine the current tapdance state
-td_state_t cur_dance(qk_tap_dance_state_t *state);
+uint8_t cur_dance(qk_tap_dance_state_t *state);
 
 // `finished` and `reset` functions for each tapdance keycode
 void altlp_finished(qk_tap_dance_state_t *state, void *user_data);
@@ -369,14 +365,14 @@ Below your `LAYOUT`, define each of the tapdance functions:
 
 ```c
 // Determine the tapdance state to return
-td_state_t cur_dance(qk_tap_dance_state_t *state) {
+uint8_t cur_dance(qk_tap_dance_state_t *state) {
     if (state->count == 1) {
-        if (state->interrupted || !state->pressed) return TD_SINGLE_TAP;
-        else return TD_SINGLE_HOLD;
+        if (state->interrupted || !state->pressed) return SINGLE_TAP;
+        else return SINGLE_HOLD;
     }
 
-    if (state->count == 2) return TD_DOUBLE_SINGLE_TAP;
-    else return TD_UNKNOWN; // Any number higher than the maximum state value you return above
+    if (state->count == 2) return DOUBLE_SINGLE_TAP;
+    else return 3; // Any number higher than the maximum state value you return above
 }
 
 // Handle the possible states for each tapdance keycode you define:
@@ -384,13 +380,13 @@ td_state_t cur_dance(qk_tap_dance_state_t *state) {
 void altlp_finished(qk_tap_dance_state_t *state, void *user_data) {
     td_state = cur_dance(state);
     switch (td_state) {
-        case TD_SINGLE_TAP:
+        case SINGLE_TAP:
             register_code16(KC_LPRN);
             break;
-        case TD_SINGLE_HOLD:
+        case SINGLE_HOLD:
             register_mods(MOD_BIT(KC_LALT)); // For a layer-tap key, use `layer_on(_MY_LAYER)` here
             break;
-        case TD_DOUBLE_SINGLE_TAP: // Allow nesting of 2 parens `((` within tapping term
+        case DOUBLE_SINGLE_TAP: // Allow nesting of 2 parens `((` within tapping term
             tap_code16(KC_LPRN);
             register_code16(KC_LPRN);
     }
@@ -398,13 +394,13 @@ void altlp_finished(qk_tap_dance_state_t *state, void *user_data) {
 
 void altlp_reset(qk_tap_dance_state_t *state, void *user_data) {
     switch (td_state) {
-        case TD_SINGLE_TAP:
+        case SINGLE_TAP:
             unregister_code16(KC_LPRN);
             break;
-        case TD_SINGLE_HOLD:
+        case SINGLE_HOLD:
             unregister_mods(MOD_BIT(KC_LALT)); // For a layer-tap key, use `layer_off(_MY_LAYER)` here
             break;
-        case TD_DOUBLE_SINGLE_TAP:
+        case DOUBLE_SINGLE_TAP:
             unregister_code16(KC_LPRN);
     }
 }
@@ -424,19 +420,17 @@ Tap Dance can be used to mimic MO(layer) and TG(layer) functionality. For this e
 The first step is to include the following code towards the beginning of your `keymap.c`:
 
 ```c
-// Define a type for as many tap dance states as you need
-typedef enum {
-    TD_NONE,
-    TD_UNKNOWN,
-    TD_SINGLE_TAP,
-    TD_SINGLE_HOLD,
-    TD_DOUBLE_TAP
-} td_state_t;
-
 typedef struct {
     bool is_press_action;
-    td_state_t state;
-} td_tap_t;
+    uint8_t state;
+} tap;
+
+// Define a type for as many tap dance states as you need
+enum {
+    SINGLE_TAP = 1,
+    SINGLE_HOLD,
+    DOUBLE_TAP
+};
 
 enum {
     QUOT_LAYR, // Our custom tap dance key; add any other tap dance keys to this enum 
@@ -445,7 +439,7 @@ enum {
 // Declare the functions to be used with your tap dance key(s)
 
 // Function associated with all tap dances
-td_state_t cur_dance(qk_tap_dance_state_t *state);
+uint8_t cur_dance(qk_tap_dance_state_t *state);
 
 // Functions associated with individual tap dances
 void ql_finished(qk_tap_dance_state_t *state, void *user_data);
@@ -456,31 +450,31 @@ Towards the bottom of your `keymap.c`, include the following code:
 
 ```c
 // Determine the current tap dance state
-td_state_t cur_dance(qk_tap_dance_state_t *state) {
+uint8_t cur_dance(qk_tap_dance_state_t *state) {
     if (state->count == 1) {
-        if (!state->pressed) return TD_SINGLE_TAP;
-        else return TD_SINGLE_HOLD;
-    } else if (state->count == 2) return TD_DOUBLE_TAP;
-    else return TD_UNKNOWN;
+        if (!state->pressed) return SINGLE_TAP;
+        else return SINGLE_HOLD;
+    } else if (state->count == 2) return DOUBLE_TAP;
+    else return 8;
 }
 
 // Initialize tap structure associated with example tap dance key
-static td_tap_t ql_tap_state = {
+static tap ql_tap_state = {
     .is_press_action = true,
-    .state = TD_NONE
+    .state = 0
 };
 
 // Functions that control what our tap dance key does
 void ql_finished(qk_tap_dance_state_t *state, void *user_data) {
     ql_tap_state.state = cur_dance(state);
     switch (ql_tap_state.state) {
-        case TD_SINGLE_TAP:
+        case SINGLE_TAP:
             tap_code(KC_QUOT);
             break;
-        case TD_SINGLE_HOLD:
+        case SINGLE_HOLD:
             layer_on(_MY_LAYER);
             break;
-        case TD_DOUBLE_TAP:
+        case DOUBLE_TAP:
             // Check to see if the layer is already set
             if (layer_state_is(_MY_LAYER)) {
                 // If already set, then switch it off
@@ -490,17 +484,15 @@ void ql_finished(qk_tap_dance_state_t *state, void *user_data) {
                 layer_on(_MY_LAYER);
             }
             break;
-        default:
-            break;
     }
 }
 
 void ql_reset(qk_tap_dance_state_t *state, void *user_data) {
     // If the key was held down and now is released then switch off the layer
-    if (ql_tap_state.state == TD_SINGLE_HOLD) {
+    if (ql_tap_state.state == SINGLE_HOLD) {
         layer_off(_MY_LAYER);
     }
-    ql_tap_state.state = TD_NONE;
+    ql_tap_state.state = 0;
 }
 
 // Associate our tap dance key with its functionality
@@ -513,7 +505,7 @@ The above code is similar to that used in previous examples. The one point to no
 
 The use of `cur_dance()` and `ql_tap_state` mirrors the above examples.
 
-The `case: TD_SINGLE_TAP` in `ql_finished` is similar to the above examples. The `TD_SINGLE_HOLD` case works in conjunction with `ql_reset()` to switch to `_MY_LAYER` while the tap dance key is held, and to switch away from `_MY_LAYER` when the key is released. This mirrors the use of `MO(_MY_LAYER)`. The `TD_DOUBLE_TAP` case works by checking whether `_MY_LAYER` is the active layer, and toggling it on or off accordingly. This mirrors the use of `TG(_MY_LAYER)`.
+The `case:SINGLE_TAP` in `ql_finished` is similar to the above examples. The `SINGLE_HOLD` case works in conjunction with `ql_reset()` to switch to `_MY_LAYER` while the tap dance key is held, and to switch away from `_MY_LAYER` when the key is released. This mirrors the use of `MO(_MY_LAYER)`. The `DOUBLE_TAP` case works by checking whether `_MY_LAYER` is the active layer, and toggling it on or off accordingly. This mirrors the use of `TG(_MY_LAYER)`.
 
 `tap_dance_actions[]` works similar to the above examples. Note that I used `ACTION_TAP_DANCE_FN_ADVANCED_TIME()` instead of `ACTION_TAP_DANCE_FN_ADVANCED()`. This is because I like my `TAPPING_TERM` to be short (\~175ms) for my non-tap-dance keys but find that this is too quick for me to reliably complete tap dance actions - thus the increased time of 275ms here.
 

docs/feature_unicode.md

@@ -126,8 +126,6 @@ The following input modes are available:
   Enabled by default and works almost anywhere on IBus-enabled distros. Without IBus, this mode works under GTK apps, but rarely anywhere else.
   By default, this mode uses Ctrl+Shift+U (`LCTL(LSFT(KC_U))`) to start Unicode input, but this can be changed by defining [`UNICODE_KEY_LNX`](#input-key-configuration) with a different keycode. This might be required for IBus versions ≥1.5.15, where Ctrl+Shift+U behavior is consolidated into Ctrl+Shift+E.
 
-  Users who wish support in non-GTK apps without IBus may need to resort to a more indirect method, such as creating a custom keyboard layout ([more on this method](#custom-linux-layout)).
-  
 * **`UC_WIN`**: _(not recommended)_ Windows built-in hex numpad Unicode input. Supports code points up to `0xFFFF`.
 
   To enable, create a registry key under `HKEY_CURRENT_USER\Control Panel\Input Method` of type `REG_SZ` called `EnableHexNumpad` and set its value to `1`. This can be done from the Command Prompt by running `reg add "HKCU\Control Panel\Input Method" -v EnableHexNumpad -t REG_SZ -d 1` with administrator privileges. Reboot afterwards.
@@ -230,7 +228,7 @@ send_unicode_string("(ノಠ痊ಠ)ノ彡┻━┻");
 
 Example uses include sending Unicode strings when a key is pressed, as described in [Macros](feature_macros.md).
 
-### `send_unicode_hex_string()` (Deprecated)
+### `send_unicode_hex_string()`
 
 Similar to `send_unicode_string()`, but the characters are represented by their Unicode code points, written in hexadecimal and separated by spaces. For example, the table flip above would be achieved with:
 
@@ -272,22 +270,3 @@ AutoHotkey inserts the Text right of `Send, ` when this combination is pressed.
 
 If you enable the US International layout on the system, it will use punctuation to accent the characters. For instance, typing "\`a" will result in à.
 You can find details on how to enable this [here](https://support.microsoft.com/en-us/help/17424/windows-change-keyboard-layout).
-
-## Software keyboard layout on Linux :id=custom-linux-layout
-
-This method does not require Unicode support on the keyboard itself but instead uses a custom keyboard layout for Xorg. This is how special characters are inserted by regular keyboards. This does not require IBus and works in practically all software. Help on creating a custom layout can be found [here](https://www.linux.com/news/creating-custom-keyboard-layouts-x11-using-xkb/), [here](http://karols.github.io/blog/2013/11/18/creating-custom-keyboard-layouts-for-linux/) and [here](https://wiki.archlinux.org/index.php/X_keyboard_extension). An example of how you could edit the `us` layout to gain 🤣 on `RALT(KC_R)`:
-
-Edit the keyboard layout file `/usr/share/X11/xkb/symbols/us`.
-
-Inside `xkb_symbols "basic" {`, add `include "level3(ralt_switch)"`.
-
-Find the line defining the R key and add an entry to the list, making it look like this:
-```
-key <AD04> {	[	  r,	R, U1F923		]	};
-```
-
-Save the file and run the command `setxkbmap us` to reload the layout.
-
-You can define one custom character for key defined in the layout, and another if you populate the fourth layer. Additional layers up to 8th are also possible.
-
-This method is specific to the computer on which you set the custom layout. The custom keys will be available only when Xorg is running. To avoid accidents, you should always reload the layout using `setxkbmap`, otherwise an invalid layout could prevent you from logging into your system, locking you out.

docs/feature_wpm.md

@@ -1,64 +1,25 @@
 # Word Per Minute (WPM) Calculcation
 
-The WPM feature uses time between keystrokes to compute a rolling average words per minute rate and makes this available for various uses.
+The WPM feature uses time between keystrokes to compute a rolling average words
+per minute rate and makes this available for various uses.
 
 Enable the WPM system by adding this to your `rules.mk`:
 
     WPM_ENABLE = yes
 
-For split keyboards using soft serial, the computed WPM score will be available on the master AND slave half.
+For split keyboards using soft serial, the computed WPM
+score will be available on the master AND slave half.
 
-## Configuration
-
-|Define                       |Default       | Description                                                                              |
-|-----------------------------|--------------|------------------------------------------------------------------------------------------|
-|`WPM_SMOOTHING`              |`0.0487`      | Sets the smoothing to about 40 keystrokes                                                |
-|`WPM_ESTIMATED_WORD_SIZE`    |`5`           | This is the value used when estimating average word size (for regression and normal use) |
-|`WPM_ALLOW_COUNT_REGRESSOIN` |_Not defined_ | If defined allows the WPM to be decreased when hitting Delete or Backspace               |
 ## Public Functions
 
-|Function                  |Description                                       |
-|--------------------------|--------------------------------------------------|
-|`get_current_wpm(void)`   | Returns the current WPM as a value between 0-255 |
-|`set_current_wpm(x)`      | Sets the current WPM to `x` (between 0-255)      |
+`uint8_t get_current_wpm(void);`
+This function returns the current WPM as an unsigned integer.
 
-## Callbacks
 
-By default, the WPM score only includes letters, numbers, space and some punctuation.  If you want to change the set of characters considered as part of the WPM calculation, you can implement your own `bool wpm_keycode_user(uint16_t keycode)` and return true for any characters you would like included in the calculation, or false to not count that particular keycode.
+## Customized keys for WPM calc
 
-For instance, the default is:
-
-```c
-bool wpm_keycode_user(uint16_t keycode) {
-    if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX) || (keycode >= QK_MODS && keycode <= QK_MODS_MAX)) {
-        keycode = keycode & 0xFF;
-    } else if (keycode > 0xFF) {
-        keycode = 0;
-    }
-    if ((keycode >= KC_A && keycode <= KC_0) || (keycode >= KC_TAB && keycode <= KC_SLASH)) {
-        return true;
-    }
-
-    return false;
-}
-```
-
-Additionally, if `WPM_ALLOW_COUNT_REGRESSION` is defined, there is the `uint8_t wpm_regress_count(uint16_t keycode)` function that allows you to decrease the WPM. This is useful if you want to be able to penalize certain keycodes (or even combinations). 
-
-```c
-__attribute__((weak)) uint8_t wpm_regress_count(uint16_t keycode) {
-    bool weak_modded = (keycode >= QK_LCTL && keycode < QK_LSFT) || (keycode >= QK_RCTL && keycode < QK_RSFT);
-    
-    if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX) || (keycode >= QK_MODS && keycode <= QK_MODS_MAX)) {
-        keycode = keycode & 0xFF;
-    } else if (keycode > 0xFF) {
-        keycode = 0;
-    }
-    if (((get_mods() | get_oneshot_mods()) & MOD_MASK_CTRL} || weak_modded) && (keycode == KC_DEL || keycode == KC_BSPC)) {
-        return WPM_ESTIMATED_WORD_SIZE;
-    }
-    if (keycode == KC_DEL || keycode == KC_BSPC) {
-        return 1;
-    }
-}
-```
+By default, the WPM score only includes letters, numbers, space and some
+punctuation.  If you want to change the set of characters considered as part of
+the WPM calculation, you can implement `wpm_keycode_user(uint16_t keycode)`
+and return true for any characters you would like included in the calculation,
+or false to not count that particular keycode.

docs/flashing.md

@@ -48,7 +48,7 @@ QMK maintains [a fork of the LUFA DFU bootloader](https://github.com/qmk/lufa/tr
 //#define QMK_LED E6
 //#define QMK_SPEAKER C6
 ```
-Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite](feature_bootmagic.md), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
+Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite](feature_bootmagic.md#bootmagic-lite), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
 
 The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string.
 
@@ -171,52 +171,6 @@ Flashing sequence:
 3. Flash a .hex file
 4. Reset the device into application mode (may be done automatically)
 
-### QMK HID
-
-QMK maintains [a fork of the LUFA HID bootloader](https://github.com/qmk/lufa/tree/master/Bootloaders/HID), which uses a USB HID Endpoint for flashing in the way that the PJRC's Teensy Loader flasher and HalfKay bootloader work. Additionally, it performs a simple matrix scan for exiting the bootloader and returning to the application, as well as flashing an LED/making a ticking noise with a speaker when things are happening.
-
-To ensure compatibility with the QMK HID bootloader, make sure this block is present in your `rules.mk`:
-
-```make
-# Bootloader selection
-BOOTLOADER = qmk-hid
-```
-
-To enable the additional features, add the following defines to your `config.h`:
-
-```c
-#define QMK_ESC_OUTPUT F1  // COL pin if COL2ROW
-#define QMK_ESC_INPUT  D5  // ROW pin if COL2ROW
-// Optional:
-//#define QMK_LED E6
-//#define QMK_SPEAKER C6
-```
-
-Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite](feature_bootmagic.md), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
-
-The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string.
-
-To generate this bootloader, use the `bootloader` target, eg. `make planck/rev4:default:bootloader`. To generate a production-ready .hex file (combining QMK and the bootloader), use the `production` target, eg. `make planck/rev4:default:production`.
-
-Compatible flashers:
-
-* TBD
-  * Currently, you need to either use the [Python script](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp_python), or compile [`hid_bootloader_cli`](https://github.com/qmk/lufa/tree/master/Bootloaders/HID/HostLoaderApp), from the LUFA repo. Homebrew may (will) have support for this directly (via `brew install qmk/qmk/hid_bootloader_cli`).
-
-Flashing sequence:
-
-1. Enter the bootloader using any of the following methods:
-    * Press the `RESET` keycode
-    * Press the `RESET` button on the PCB if available
-    * short RST to GND quickly
-2. Wait for the OS to detect the device
-3. Flash a .hex file
-4. Reset the device into application mode (may be done automatically)
-
-### `make` Targets
-
-* `:qmk-hid`: Checks every 5 seconds until a DFU device is available, and then flashes the firmware.
-
 ## STM32/APM32 DFU
 
 All STM32 and APM32 MCUs, except for F103 (see the [STM32duino section](#stm32duino)) come preloaded with a factory bootloader that cannot be modified nor deleted.
@@ -295,29 +249,3 @@ Flashing sequence:
 2. Wait for the OS to detect the device
 3. Flash a .bin file
 4. Reset the device into application mode (may be done automatically)
-
-## tinyuf2
-
-Keyboards may opt into supporting the tinyuf2 bootloader. This is currently only supported on the F401/F411 blackpill.
-
-The `rules.mk` setting for this bootloader is `tinyuf2`, and can be specified at the keymap or user level.
-
-To ensure compatibility with the tinyuf2 bootloader, make sure this block is present in your `rules.mk`:
-
-```make
-# Bootloader selection
-BOOTLOADER = tinyuf2
-```
-
-Compatible flashers:
-
-* Any application able to copy a file from one place to another, such as _macOS Finder_ or _Windows Explorer_.
-
-Flashing sequence:
-
-1. Enter the bootloader using any of the following methods:
-    * Tap the `RESET` keycode
-    * Double-tap the `nRST` button on the PCB.
-2. Wait for the OS to detect the device
-3. Copy the .uf2 file to the new USB disk
-4. Wait for the keyboard to become available

docs/fr-fr/README.md

@@ -1,14 +1,15 @@
 # Quantum Mechanical Keyboard Firmware
 
 [![Version courante](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
+[![Statut du build](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
 [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
 [![Statut de la doc](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
 [![Contributeurs GitHub](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
 [![Forks GitHub](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
 
-## Qu'est-ce que QMK Firmware?
+## Qu'est-ce que QMK Firmware ?
 
-QMK (*Quantum Mechanical Keyboard*) est une communauté open source qui maintient le firmware QMK, la QMK Toolbox (*Boite à outil*), qmk.fm et leurs documentations. QMK Firmware est un firmware dédié aux claviers qui est basé sur [tmk\_keyboard](https://github.com/tmk/tmk_keyboard). Il offre des fonctionnalités très utiles pour les contrôleurs Atmel AVR, et, plus spécifiquement pour [les produits d'OLKB](https://olkb.com), le clavier [ErgoDox EZ](https://www.ergodox-ez.com), et pour les [produits Clueboard](https://clueboard.co/). Il prend désormais aussi en charge les processeurs ARM qui utilisent ChibiOS. Vous pouvez l'utiliser pour contrôler un clavier personnalisé soudé à la main ou alors sur un clavier avec un PCB personnalisé.
+QMK (*Quantum Mechanical Keyboard*) est une communauté open source qui maintient le firmware QMK, la QMK Toolbox (*Boite à outil*), qmk.fm et leurs documentations. QMK Firmware est un firmware dédié aux claviers qui est basé sur [tmk\_keyboard](https://github.com/tmk/tmk_keyboard). Il offre des fonctionnalités très utiles pour les contrôleurs Atmel AVR, et, plus spécifiquement pour [les produits d'OLKB](https://olkb.com), le clavier [ErgoDox EZ](https://www.ergodox-ez.com), et pour les [produits Clueboard](https://clueboard.co/). Il prend désormais aussi en charge les processeurs ARM qui utilisent ChibiOS. Vous pouvez l'utiliser pour contrôler un clavier personnalisé soudé à la main ou alors sur un clavier avec un PCB personnalisé.
 
 ## Comment l'obtenir
 
@@ -22,7 +23,7 @@ Avant d'être prêt à compiler vous allez devoir [installer un environnement](f
 
     make planck/rev4:default
 
-Cette commande compilera la révision `rev4` du clavier `planck` avec la disposition `default`. Notez que tous les claviers n'ont pas forcément de révisions (aussi appelées sous-projects ou dossiers, ou en anglais «subprojects» ou «folder»). Cette option peut donc être omise:
+Cette commande compilera la révision `rev4` du clavier `planck` avec la disposition `default`. Notez que tous les claviers n'ont pas forcément de révisions (aussi appelées sous-projects ou dossiers, ou en anglais « subprojects » ou « folder »). Cette option peut donc être omise :
 
     make preonic:default