Migrate build target markers to keyboard.json

2024-05-26 23:36:49 +01:00
1017 changed files with 29007 additions and 22798 deletions
@@ -1,7 +1,7 @@
 blank_issues_enabled: false
 contact_links:
  - name: QMK Discord
-    url: https://discord.gg/qmk
+    url: https://discord.gg/Uq7gcHh
    about: Ask questions, discuss issues and features. Chill.
  - name: OLKB Subreddit
    url: https://www.reddit.com/r/olkb
@@ -1,56 +1,46 @@
 core:
-  - changed-files:
-    - any-glob-to-any-file:
-      - quantum/**
-      - tmk_core/**
-      - drivers/**
-      - tests/**
-      - util/**
-      - platforms/**
-      - builddefs/*.mk
-      - Makefile
-      - '*.mk'
+  - quantum/**/*
+  - tmk_core/**/*
+  - drivers/**/*
+  - tests/**/*
+  - util/**/*
+  - platforms/**/*
+  - builddefs/**/*
+  - Makefile
+  - '*.mk'
 dependencies:
-  - all:
-    - changed-files:
-      - any-glob-to-any-file: lib/**
-      - all-globs-to-all-files: '!lib/python/**'
+  - any:
+    - 'lib/**/*'
+    - '!lib/python/**/*'
 keyboard:
-  - all:
-    - changed-files:
-      - any-glob-to-any-file: keyboards/**
-      - all-globs-to-all-files: '!keyboards/**/keymaps/**'
+  - any:
+    - 'keyboards/**/*'
+    - '!keyboards/**/keymaps/**/*'
 keymap:
-  - changed-files:
-    - any-glob-to-any-file:
-      - users/**
-      - layouts/**
-      - keyboards/**/keymaps/**
+  - users/**/*
+  - layouts/**/*
+  - keyboards/**/keymaps/**/*
 via:
-  - changed-files:
-    - any-glob-to-any-file:
-      - keyboards/**/keymaps/via/*
+  - keyboards/**/keymaps/via/*
 cli:
-  - changed-files:
-    - any-glob-to-any-file:
-      - requirements.txt
-      - lib/python/**
+  - requirements.txt
+  - lib/python/**/*
 python:
-  - changed-files:
-    - any-glob-to-any-file:
-      - '**/*.py'
+  - '**/*.py'
 documentation:
-  - changed-files:
-    - any-glob-to-any-file:
-      - docs/**
-      - builddefs/docsgen/**
+  - docs/**/*
+translation:
+  - docs/fr-fr/**/*
+  - docs/es/**/*
+  - docs/ja/**/*
+  - docs/he-il/**/*
+  - docs/pt-br/**/*
+  - docs/zh-cn/**/*
+  - docs/de/**/*
+  - docs/ru-ru/**/*
 CI:
-  - changed-files:
-    - any-glob-to-any-file:
-      - .github/**
+  - .github/**/*
 dd:
-  - changed-files:
-    - any-glob-to-any-file:
-      - data/constants/**
-      - data/mappings/**
-      - data/schemas/**
+  - data/constants/**/*
+  - data/mappings/**/*
+  - data/schemas/**/*
@@ -13,8 +13,8 @@ jobs:
    if: github.repository == 'qmk/qmk_firmware'

    steps:
-    - uses: zvecr/automatic-approve-action@safe_files
+    - uses: mheap/automatic-approve-action@v1
      with:
        token: ${{ secrets.QMK_BOT_TOKEN }}
-        workflows: "labeler.yml,lint.yml,docs.yml"
-        safe_files: "keyboards/,docs/"
+        workflows: "format.yml,lint.yml,unit_test.yml"
+        dangerous_files: "lib/python/,Makefile,paths.mk,builddefs/"
@@ -52,9 +52,9 @@ jobs:
        run: |
          target_count=$( {
            qmk find -km default 2>/dev/null
-            # qmk find -km xap 2>/dev/null
+            qmk find -km via 2>/dev/null
          } | sort | uniq | wc -l)
-          slice_length=$((target_count / ($CONCURRENT_JOBS - 1))) # Err on the side of caution
+          slice_length=$((target_count / ($CONCURRENT_JOBS - 1))) # Err on the side of caution as we're splitting default and via
          echo "slice_length=$slice_length" >> $GITHUB_OUTPUT

  build_targets:
@@ -63,8 +63,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        keymap: [default]
-        # keymap: [default, xap]
+        keymap: [default, via]
    uses: ./.github/workflows/ci_build_major_branch_keymap.yml
    with:
      branch: ${{ inputs.branch || github.ref_name }}
@@ -78,59 +77,44 @@ jobs:
    runs-on: ubuntu-latest

    steps:
-      - name: Disable safe.directory check
-        run: |
-          git config --global --add safe.directory '*'
-
-      - name: Checkout QMK Firmware
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
      - name: Download firmwares
        uses: actions/download-artifact@v4
        with:
          pattern: firmware-*
-          path: .
+          path: firmwares
          merge-multiple: true

-      - name: Generate index page
-        run: |
-          python3 -m pip install -r ./util/ci/requirements.txt
-          ./util/ci/index_generator.py > index.html
-          ./util/ci/firmware_list_generator.py > firmware_list.json
-
      - name: Upload to https://ci.qmk.fm/${{ inputs.branch || github.ref_name }}/${{ github.sha }}
        uses: jakejarvis/s3-sync-action@master
        with:
-          args: --acl public-read --follow-symlinks --delete --exclude '*' --include 'index.html' --include 'firmware_list.json' --include '*.hex' --include '*.bin' --include '*.uf2'
+          args: --acl public-read --follow-symlinks --delete
        env:
          AWS_S3_BUCKET: ${{ vars.CI_QMK_FM_SPACES_BUCKET }}
          AWS_ACCESS_KEY_ID: ${{ secrets.CI_QMK_FM_SPACES_KEY }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.CI_QMK_FM_SPACES_SECRET }}
          AWS_REGION: ${{ vars.CI_QMK_FM_SPACES_REGION }}
          AWS_S3_ENDPOINT: ${{ vars.CI_QMK_FM_SPACES_ENDPOINT }}
-          SOURCE_DIR: .
+          SOURCE_DIR: firmwares
          DEST_DIR: ${{ inputs.branch || github.ref_name }}/${{ github.sha }}

      - name: Upload to https://ci.qmk.fm/${{ inputs.branch || github.ref_name }}/latest
        uses: jakejarvis/s3-sync-action@master
        with:
-          args: --acl public-read --follow-symlinks --delete --exclude '*' --include 'index.html' --include 'firmware_list.json' --include '*.hex' --include '*.bin' --include '*.uf2'
+          args: --acl public-read --follow-symlinks --delete
        env:
          AWS_S3_BUCKET: ${{ vars.CI_QMK_FM_SPACES_BUCKET }}
          AWS_ACCESS_KEY_ID: ${{ secrets.CI_QMK_FM_SPACES_KEY }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.CI_QMK_FM_SPACES_SECRET }}
          AWS_REGION: ${{ vars.CI_QMK_FM_SPACES_REGION }}
          AWS_S3_ENDPOINT: ${{ vars.CI_QMK_FM_SPACES_ENDPOINT }}
-          SOURCE_DIR: .
+          SOURCE_DIR: firmwares
          DEST_DIR: ${{ inputs.branch || github.ref_name }}/latest

      - name: Check if failure marker file exists
        id: check_failure_marker
        uses: andstor/file-existence-action@v3
        with:
-          files: ./.failed
+          files: firmwares/.failed

      - name: Fail build if needed
        if: steps.check_failure_marker.outputs.files_exists == 'true'
@@ -108,7 +108,7 @@ jobs:
      - name: Build targets
        continue-on-error: true
        run: |
-          export NCPUS=$(( $(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null) -1 ))
+          export NCPUS=$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null)
          qmk mass-compile -t -j $NCPUS -e DUMP_CI_METADATA=yes $(jq -r '.["${{ matrix.target }}"].targets' targets.json) || touch .failed

      - name: Upload binaries
@@ -172,10 +172,10 @@ jobs:
            targets-${{ inputs.keymap }}

      - name: 'CI Discord Notification'
-        if: always() && !cancelled()
+        if: always()
        working-directory: util/ci/
        env:
          DISCORD_WEBHOOK: ${{ secrets.CI_DISCORD_WEBHOOK }}
        run: |
          python3 -m pip install -r requirements.txt
-          python3 ./discord-results.py --branch ${{ inputs.branch || github.ref_name }} --sha $(git rev-parse HEAD) --keymap ${{ inputs.keymap }} --url ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          python3 ./discord-results.py --branch ${{ inputs.branch || github.ref_name }} --keymap ${{ inputs.keymap }} --url ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
@@ -8,27 +8,20 @@ on:
    branches:
    - master
    paths:
-    - 'builddefs/docsgen/**'
    - 'tmk_core/**'
    - 'quantum/**'
    - 'platforms/**'
    - 'docs/**'
    - '.github/workflows/docs.yml'
-  pull_request:
-    paths:
-    - 'builddefs/docsgen/**'
-    - 'docs/**'
-    - '.github/workflows/docs.yml'
-
-defaults:
-  run:
-    shell: bash

 jobs:
  generate:
    runs-on: ubuntu-latest
    container: ghcr.io/qmk/qmk_cli

+    # protect against those who develop with their fork on master
+    if: github.repository == 'qmk/qmk_firmware'
+
    steps:
    - uses: actions/checkout@v4
      with:
@@ -36,30 +29,18 @@ jobs:

    - name: Install dependencies
      run: |
-        apt-get update && apt-get install -y rsync doxygen
-        # install nvm
-        touch $HOME/.bashrc
-        wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
-
-    - name: Install node
-      run: |
-        source $HOME/.bashrc
-        nvm install 20
-        nvm use 20
-        corepack enable
+        apt-get update && apt-get install -y rsync nodejs npm doxygen
+        npm install -g moxygen

    - name: Build docs
      run: |
-        source $HOME/.bashrc
-        nvm use 20
        qmk --verbose generate-docs

    - name: Deploy
-      if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
-      uses: JamesIves/github-pages-deploy-action@v4.6.3
+      uses: JamesIves/github-pages-deploy-action@v4.6.1
      with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          branch: gh-pages
-          folder: .build/docs
-          git-config-name: QMK Bot
-          git-config-email: hello@qmk.fm
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        BASE_BRANCH: master
+        BRANCH: gh-pages
+        FOLDER: .build/docs
+        GIT_CONFIG_EMAIL: hello@qmk.fm
@@ -1,13 +1,18 @@
 name: "Pull Request Labeler"

+permissions:
+  contents: read
+  pull-requests: write
+
 on:
- pull_request_target
+  pull_request_target:
+    types: [opened, synchronize, reopened, ready_for_review, locked]

 jobs:
  triage:
-    permissions:
-      contents: read
-      pull-requests: write
    runs-on: ubuntu-latest
    steps:
-    - uses: actions/labeler@v5
+    - uses: actions/labeler@v4
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+        configuration-path: '.github/labeler.yml'
@@ -25,8 +25,6 @@
 *.la
 *.stackdump
 *.sym
-index.html
-firmware_list.json

 # QMK-specific
 api_data/v1
@@ -21,7 +21,7 @@ DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "QMK Firmware"
 PROJECT_NUMBER         = https://github.com/qmk/qmk_firmware
 PROJECT_BRIEF          = "Keyboard controller firmware for Atmel AVR and ARM USB families"
-OUTPUT_DIRECTORY       = .build/docs/static/doxygen
+OUTPUT_DIRECTORY       = .build/doxygen
 ALLOW_UNICODE_NAMES    = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
@@ -40,8 +40,8 @@ ABBREVIATE_BRIEF       = "The $name class" \
 ALWAYS_DETAILED_SEC    = NO
 INLINE_INHERITED_MEMB  = NO
 FULL_PATH_NAMES        = YES
-STRIP_FROM_PATH        =
-STRIP_FROM_INC_PATH    =
+STRIP_FROM_PATH        = 
+STRIP_FROM_INC_PATH    = 
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = NO
 QT_AUTOBRIEF           = NO
@@ -49,13 +49,13 @@ MULTILINE_CPP_IS_BRIEF = NO
 INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 4
-ALIASES                =
-TCL_SUBST              =
+ALIASES                = 
+TCL_SUBST              = 
 OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = NO
 OPTIMIZE_FOR_FORTRAN   = NO
 OPTIMIZE_OUTPUT_VHDL   = NO
-EXTENSION_MAPPING      =
+EXTENSION_MAPPING      = 
 MARKDOWN_SUPPORT       = YES
 TOC_INCLUDE_HEADINGS   = 2
 AUTOLINK_SUPPORT       = YES
@@ -104,14 +104,14 @@ GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
 GENERATE_BUGLIST       = YES
 GENERATE_DEPRECATEDLIST= YES
-ENABLED_SECTIONS       =
+ENABLED_SECTIONS       = 
 MAX_INITIALIZER_LINES  = 30
 SHOW_USED_FILES        = YES
 SHOW_FILES             = YES
 SHOW_NAMESPACES        = YES
-FILE_VERSION_FILTER    =
-LAYOUT_FILE            =
-CITE_BIB_FILES         =
+FILE_VERSION_FILTER    = 
+LAYOUT_FILE            = 
+CITE_BIB_FILES         = 

 #---------------------------------------------------------------------------
 # Configuration options related to warning and progress messages
@@ -124,7 +124,7 @@ WARN_IF_DOC_ERROR      = YES
 WARN_NO_PARAMDOC       = NO
 WARN_AS_ERROR          = NO
 WARN_FORMAT            = "$file:$line: $text"
-WARN_LOGFILE           =
+WARN_LOGFILE           = 

 #---------------------------------------------------------------------------
 # Configuration options related to the input files
@@ -143,19 +143,19 @@ FILE_PATTERNS          = *.c \
                         *.hpp \
                         *.h++
 RECURSIVE              = YES
-EXCLUDE                =
+EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = */protocol/arm_atsam/*
-EXCLUDE_SYMBOLS        =
-EXAMPLE_PATH           =
+EXCLUDE_SYMBOLS        = 
+EXAMPLE_PATH           = 
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             =
-INPUT_FILTER           =
-FILTER_PATTERNS        =
+IMAGE_PATH             = 
+INPUT_FILTER           = 
+FILTER_PATTERNS        = 
 FILTER_SOURCE_FILES    = NO
-FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE =
+FILTER_SOURCE_PATTERNS = 
+USE_MDFILE_AS_MAINPAGE = 

 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -177,7 +177,7 @@ VERBATIM_HEADERS       = YES

 ALPHABETICAL_INDEX     = YES
 COLS_IN_ALPHA_INDEX    = 5
-IGNORE_PREFIX          =
+IGNORE_PREFIX          = 

 #---------------------------------------------------------------------------
 # Configuration options related to disabled outputs
@@ -207,18 +207,18 @@ ENABLE_PREPROCESSING   = YES
 MACRO_EXPANSION        = NO
 EXPAND_ONLY_PREDEF     = NO
 SEARCH_INCLUDES        = YES
-INCLUDE_PATH           =
-INCLUDE_FILE_PATTERNS  =
+INCLUDE_PATH           = 
+INCLUDE_FILE_PATTERNS  = 
 PREDEFINED             = __DOXYGEN__ PROGMEM
-EXPAND_AS_DEFINED      =
+EXPAND_AS_DEFINED      = 
 SKIP_FUNCTION_MACROS   = YES

 #---------------------------------------------------------------------------
 # Configuration options related to external references
 #---------------------------------------------------------------------------

-TAGFILES               =
-GENERATE_TAGFILE       =
+TAGFILES               = 
+GENERATE_TAGFILE       = 
 ALLEXTERNALS           = NO
 EXTERNAL_GROUPS        = YES
 EXTERNAL_PAGES         = YES
@@ -229,14 +229,14 @@ PERL_PATH              = /usr/bin/perl
 #---------------------------------------------------------------------------

 CLASS_DIAGRAMS         = YES
-MSCGEN_PATH            =
-DIA_PATH               =
+MSCGEN_PATH            = 
+DIA_PATH               = 
 HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = NO
 DOT_NUM_THREADS        = 0
 DOT_FONTNAME           = Helvetica
 DOT_FONTSIZE           = 10
-DOT_FONTPATH           =
+DOT_FONTPATH           = 
 CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = YES
 GROUP_GRAPHS           = YES
@@ -251,13 +251,13 @@ GRAPHICAL_HIERARCHY    = YES
 DIRECTORY_GRAPH        = YES
 DOT_IMAGE_FORMAT       = png
 INTERACTIVE_SVG        = NO
-DOT_PATH               =
-DOTFILE_DIRS           =
-MSCFILE_DIRS           =
-DIAFILE_DIRS           =
-PLANTUML_JAR_PATH      =
-PLANTUML_CFG_FILE      =
-PLANTUML_INCLUDE_PATH  =
+DOT_PATH               = 
+DOTFILE_DIRS           = 
+MSCFILE_DIRS           = 
+DIAFILE_DIRS           = 
+PLANTUML_JAR_PATH      = 
+PLANTUML_CFG_FILE      = 
+PLANTUML_INCLUDE_PATH  = 
 DOT_GRAPH_MAX_NODES    = 50
 MAX_DOT_GRAPH_DEPTH    = 0
 DOT_TRANSPARENT        = NO
@@ -465,18 +465,3 @@ distclean_userspace: clean
 	rm -f $(QMK_USERSPACE)/*.bin $(QMK_USERSPACE)/*.hex $(QMK_USERSPACE)/*.uf2
 	echo 'done.'
 endif
-
-# Extra targets for formatting and/or pytest, running within the qmk/qmk_cli container to match GHA.
-CONTAINER_PREAMBLE := export HOME="/tmp"; export PATH="/tmp/.local/bin:\$$PATH"; python3 -m pip install --upgrade pip; python3 -m pip install -r requirements-dev.txt
-
-.PHONY: format-core
-format-core:
-	RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a"
-
-.PHONY: pytest
-pytest:
-	RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk pytest"
-
-.PHONY: format-and-pytest
-format-and-pytest:
-	RUNTIME=docker ./util/docker_cmd.sh bash -lic "$(CONTAINER_PREAMBLE); qmk format-c --core-only -a && qmk format-python -a && qmk pytest"
@@ -34,13 +34,10 @@ ifeq ($(strip $(DUMP_CI_METADATA)),yes)
 endif

 # Force expansion
-override TARGET := $(TARGET)
+TARGET := $(TARGET)

 ifneq ($(FORCE_LAYOUT),)
-    override TARGET := $(TARGET)_$(FORCE_LAYOUT)
-endif
-ifneq ($(CONVERT_TO),)
-    override TARGET := $(TARGET)_$(CONVERT_TO)
+    TARGET := $(TARGET)_$(FORCE_LAYOUT)
 endif

 # Object files and generated keymap directory
@@ -61,6 +58,9 @@ ifdef SKIP_GIT
 VERSION_H_FLAGS += --skip-git
 endif

+# Generate the board's version.h file.
+$(shell $(QMK_BIN) generate-version-h $(VERSION_H_FLAGS) -q -o $(INTERMEDIATE_OUTPUT)/src/version.h)
+
 # Determine which subfolders exist.
 KEYBOARD_FOLDER_PATH_1 := $(KEYBOARD)
 KEYBOARD_FOLDER_PATH_2 := $(patsubst %/,%,$(dir $(KEYBOARD_FOLDER_PATH_1)))
@@ -218,9 +218,6 @@ endif

 include $(BUILDDEFS_PATH)/converters.mk

-# Generate the board's version.h file.
-$(shell $(QMK_BIN) generate-version-h $(VERSION_H_FLAGS) -q -o $(INTERMEDIATE_OUTPUT)/src/version.h)
-
 MCU_ORIG := $(MCU)
 include $(wildcard $(PLATFORM_PATH)/*/mcu_selection.mk)

@@ -32,6 +32,9 @@ ifneq ($(CONVERT_TO),)

    PLATFORM_KEY = $(shell echo $(CONVERTER) | cut -d "/" -f2)

+    # force setting as value can be from environment
+    override TARGET := $(TARGET)_$(CONVERT_TO)
+
    # Configure any defaults
    OPT_DEFS += -DCONVERT_TO_$(shell echo $(CONVERT_TO) | tr '[:lower:]' '[:upper:]')
    OPT_DEFS += -DCONVERTER_TARGET=\"$(CONVERT_TO)\"
@@ -1,5 +0,0 @@
-node_modules
-.vitepress/cache
-.vitepress/.temp
-.vitepress/dist
-docs
@@ -1,51 +0,0 @@
-import { defineConfig } from "vitepress";
-import { tabsMarkdownPlugin } from "vitepress-plugin-tabs";
-import sidebar from "../../../docs/_sidebar.json";
-
-// https://vitepress.dev/reference/site-config
-export default defineConfig(({ mode }) => {
-    const prod = mode === "production";
-    return {
-        title: "QMK Firmware",
-        description: "Documentation for QMK Firmware",
-
-        srcDir: prod ? "docs" : "../../docs",
-        outDir: "../../.build/docs",
-        cleanUrls: true,
-
-        markdown: {
-            config(md) {
-                md.use(tabsMarkdownPlugin);
-            },
-        },
-
-        vite: {
-            resolve: {
-                preserveSymlinks: true,
-            },
-        },
-
-        themeConfig: {
-            // https://vitepress.dev/reference/default-theme-config
-            logo: {
-                light: "/qmk-logo-light.svg",
-                dark: "/qmk-logo-dark.svg",
-            },
-            title: 'QMK Firmware',
-
-            nav: [{ text: "Home", link: "/" }],
-
-            search: {
-                provider: "local",
-            },
-
-            sidebar: sidebar,
-
-            socialLinks: [
-                { icon: { svg: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719 4.3125 31.3125 3.84375 C 30.738281 3.375 29.9375 3 29 3 Z M 41 5 C 42.667969 5 44 6.332031 44 8 C 44 9.667969 42.667969 11 41 11 C 39.332031 11 38 9.667969 38 8 C 38 6.332031 39.332031 5 41 5 Z M 25 15 C 30.609375 15 35.675781 16.613281 39.28125 19.1875 C 42.886719 21.761719 45 25.226563 45 29 C 45 32.773438 42.886719 36.238281 39.28125 38.8125 C 35.675781 41.386719 30.609375 43 25 43 C 19.390625 43 14.324219 41.386719 10.71875 38.8125 C 7.113281 36.238281 5 32.773438 5 29 C 5 25.226563 7.113281 21.761719 10.71875 19.1875 C 14.324219 16.613281 19.390625 15 25 15 Z M 7.5 16.9375 C 8.203125 16.9375 8.914063 17.148438 9.53125 17.59375 C 7.527344 19.03125 5.886719 20.769531 4.75 22.71875 C 3.582031 21.296875 3.660156 19.339844 5 18 C 5.714844 17.285156 6.609375 16.9375 7.5 16.9375 Z M 42.5 16.9375 C 43.390625 16.9375 44.285156 17.285156 45 18 C 46.339844 19.339844 46.417969 21.296875 45.25 22.71875 C 44.113281 20.769531 42.472656 19.03125 40.46875 17.59375 C 41.085938 17.148438 41.796875 16.9375 42.5 16.9375 Z M 17 22 C 14.800781 22 13 23.800781 13 26 C 13 28.199219 14.800781 30 17 30 C 19.199219 30 21 28.199219 21 26 C 21 23.800781 19.199219 22 17 22 Z M 33 22 C 30.800781 22 29 23.800781 29 26 C 29 28.199219 30.800781 30 33 30 C 35.199219 30 37 28.199219 37 26 C 37 23.800781 35.199219 22 33 22 Z M 17 24 C 18.117188 24 19 24.882813 19 26 C 19 27.117188 18.117188 28 17 28 C 15.882813 28 15 27.117188 15 26 C 15 24.882813 15.882813 24 17 24 Z M 33 24 C 34.117188 24 35 24.882813 35 26 C 35 27.117188 34.117188 28 33 28 C 31.882813 28 31 27.117188 31 26 C 31 24.882813 31.882813 24 33 24 Z M 34.15625 33.84375 C 34.101563 33.851563 34.050781 33.859375 34 33.875 C 33.683594 33.9375 33.417969 34.144531 33.28125 34.4375 C 33.28125 34.4375 32.757813 35.164063 31.4375 36 C 30.117188 36.835938 28.058594 37.6875 25 37.6875 C 21.941406 37.6875 19.882813 36.835938 18.5625 36 C 17.242188 35.164063 16.71875 34.4375 16.71875 34.4375 C 16.492188 34.082031 16.066406 33.90625 15.65625 34 C 15.332031 34.082031 15.070313 34.316406 14.957031 34.632813 C 14.84375 34.945313 14.894531 35.292969 15.09375 35.5625 C 15.09375 35.5625 15.863281 36.671875 17.46875 37.6875 C 19.074219 38.703125 21.558594 39.6875 25 39.6875 C 28.441406 39.6875 30.925781 38.703125 32.53125 37.6875 C 34.136719 36.671875 34.90625 35.5625 34.90625 35.5625 C 35.207031 35.273438 35.296875 34.824219 35.128906 34.441406 C 34.960938 34.058594 34.574219 33.820313 34.15625 33.84375 Z"/></svg>' }, link: "https://reddit.com/r/olkb" },
-                { icon: "discord", link: "https://discord.gg/qmk" },
-                { icon: "github", link: "https://github.com/qmk/qmk_firmware" },
-            ],
-        }
-    };
-});
@@ -1,29 +0,0 @@
-<script setup>
-import DefaultTheme from 'vitepress/theme'
-import { useRouter } from 'vitepress'
-import { onBeforeMount } from 'vue';
-import aliases from "../../../../docs/_aliases.json";
-
-const router = useRouter()
-onBeforeMount(async () => {
-    // Convert from docsify-style to vitepress-style URLs
-    let newUrl = window.location.href.replace(/\/#\//, '/').replace(/\?id=/, '#');
-
-    // Convert any aliases
-    let testUrl = new URL(newUrl);
-    while (testUrl.pathname in aliases) {
-        testUrl.pathname = aliases[testUrl.pathname];
-    }
-    newUrl = testUrl.toString();
-
-    // Redirect if required
-    if (newUrl != window.location.href) {
-        window.history.replaceState({}, '', newUrl);
-        await router.go(newUrl);
-    }
-});
-</script>
-
-<template>
-    <DefaultTheme.Layout/>
-</template>
@@ -1,19 +0,0 @@
-/* Override <kbd> as vitepress doesn't put them with borders */
-kbd {
-    border: 1px solid var(--vp-c-text-1);
-    border-radius: 5px;
-    margin: 0.2em;
-    padding: 0.2em;
-}
-
-:root {
-    --vp-nav-logo-height: 32px;
-
-    --vp-layout-max-width: calc(98% + 64px);
-
-    --vp-sidebar-width: 300px;
-}
-
-.VPDoc.has-aside .content-container {
-    max-width: unset !important;
-}
@@ -1,13 +0,0 @@
-import type { Theme } from 'vitepress'
-import DefaultTheme from 'vitepress/theme'
-import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client'
-import QMKLayout from './QMKLayout.vue'
-import './custom.css'
-
-export default {
-  extends: DefaultTheme,
-  Layout: QMKLayout,
-  enhanceApp({ app }) {
-    enhanceAppWithTabs(app)
-  }
-} satisfies Theme
@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-
-cd "$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
-yarn install
-[[ -e docs ]] || ln -sf ../../docs docs
-DEBUG='vitepress:*,vite:*' yarn run docs:build
@@ -1,14 +0,0 @@
-{
-  "license": "GPL-2.0-or-later",
-  "devDependencies": {
-    "vite": "^5.2.10",
-    "vitepress": "^1.1.0",
-    "vitepress-plugin-tabs": "^0.5.0",
-    "vue": "^3.4.24"
-  },
-  "scripts": {
-    "docs:dev": "vitepress dev --host 0.0.0.0",
-    "docs:build": "vitepress build",
-    "docs:preview": "vitepress preview --host 0.0.0.0"
-  }
-}
@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-cd "$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
-yarn install
-DEBUG='vitepress:*,vite:*' yarn run docs:dev
@@ -16,6 +16,12 @@
        "type": "object",
        "additionalProperties": {"type": "boolean"}
    },
+    "build_target": {
+        "oneOf": [
+            {"$ref": "#/keyboard_keymap_tuple"},
+            {"$ref": "#/json_file_path"}
+        ]
+    },
    "filename": {
        "type": "string",
        "minLength": 1,
@@ -34,8 +40,7 @@
        "pattern": "^[0-9a-z_/\\-]+\\.json$"
    },
    "key_unit": {
-        "type": "number",
-        "minimum": 0
+        "type": "number"
    },
    "keyboard": {
        "type": "string",
@@ -47,19 +52,6 @@
            {"$ref": "#/keyboard"},
            {"$ref": "#/filename"}
        ],
-        "minItems": 2,
-        "maxItems": 2,
-        "unevaluatedItems": false
-    },
-    "keyboard_keymap_env": {
-        "type": "array",
-        "prefixItems": [
-            {"$ref": "#/keyboard"},
-            {"$ref": "#/filename"},
-            {"$ref": "#/kvp_object"}
-        ],
-        "minItems": 3,
-        "maxItems": 3,
        "unevaluatedItems": false
    },
    "keycode": {
@@ -94,10 +86,6 @@
        "maxLength": 7,
        "pattern": "^[A-Z][A-Zs_0-9]*$"
    },
-    "kvp_object": {
-        "type": "object",
-        "additionalProperties": {"type": "string"}
-    },
    "layout_macro": {
        "oneOf": [
            {
@@ -515,8 +515,8 @@
                                    "minimum": 0
                                }
                            },
-                            "x": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                            "y": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                            "x": {"$ref": "qmk.definitions.v1#/key_unit"},
+                            "y": {"$ref": "qmk.definitions.v1#/key_unit"},
                            "flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
                        }
                    }
@@ -601,8 +601,8 @@
                                    "minimum": 0
                                }
                            },
-                            "x": {"$ref": "qmk.definitions.v1#/unsigned_int"},
-                            "y": {"$ref": "qmk.definitions.v1#/unsigned_int"},
+                            "x": {"$ref": "qmk.definitions.v1#/key_unit"},
+                            "y": {"$ref": "qmk.definitions.v1#/key_unit"},
                            "flags": {"$ref": "qmk.definitions.v1#/unsigned_int_8"}
                        }
                    }
@@ -3,14 +3,6 @@
    "$id": "qmk.user_repo.v1",
    "title": "User Repository Information",
    "type": "object",
-    "definitions": {
-        "build_target": {
-            "oneOf": [
-                {"$ref": "qmk.definitions.v1#/keyboard_keymap_tuple"},
-                {"$ref": "qmk.definitions.v1#/json_file_path"}
-            ]
-        },
-    },
    "required": [
        "userspace_version",
        "build_targets"
@@ -23,7 +15,7 @@
        "build_targets": {
            "type": "array",
            "items": {
-                "$ref": "#/definitions/build_target"
+                "$ref": "qmk.definitions.v1#/build_target"
            }
        }
    }
@@ -1,31 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema#",
-    "$id": "qmk.user_repo.v1_1",
-    "title": "User Repository Information",
-    "type": "object",
-    "definitions": {
-        "build_target": {
-            "oneOf": [
-                {"$ref": "qmk.definitions.v1#/keyboard_keymap_tuple"},
-                {"$ref": "qmk.definitions.v1#/keyboard_keymap_env"},
-                {"$ref": "qmk.definitions.v1#/json_file_path"}
-            ]
-        },
-    },
-    "required": [
-        "userspace_version",
-        "build_targets"
-    ],
-    "properties": {
-        "userspace_version": {
-            "type": "string",
-            "enum": ["1.1"]
-        },
-        "build_targets": {
-            "type": "array",
-            "items": {
-                "$ref": "#/definitions/build_target"
-            }
-        }
-    }
-}
@@ -2,6 +2,8 @@
    "keyboard_name": "%KEYBOARD%",
    "maintainer": "%USER_NAME%",
    "manufacturer": "%REAL_NAME%",
+    "processor": "%MCU%",
+    "bootloader": "%BOOTLOADER%",
    "diode_direction": "COL2ROW",
    "matrix_pins": {
        "cols": ["C2"],
@@ -0,0 +1 @@
+docs.qmk.fm
@@ -20,7 +20,7 @@ This document marks the inaugural Breaking Change merge. A list of changes follo

 * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()`
 * The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity
-* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features
+* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features

 ## Update Atreus to current code conventions

@@ -43,7 +43,7 @@ This document marks the inaugural Breaking Change merge. A list of changes follo

 * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()`
 * All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys
-* If you currently use `KC_FN*` you will need to replace `fn_actions` with the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features
+* If you currently use `KC_FN*` you will need to replace `fn_actions` with the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features

 ## Remove `KC_DELT` alias in favor of `KC_DEL`

@@ -51,7 +51,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch

 * `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()`
 * The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity
-* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features
+* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features


 ## Moving backlight keycode handling to `process_keycode/`
--- a/Show More
+++ b/Show More