From afe40027a478b44dac3f6cbc17fc5c7700fb910e Mon Sep 17 00:00:00 2001 From: rasmuskoit Date: Mon, 5 Aug 2024 20:59:18 +0300 Subject: [PATCH] rename from splits to dongle --- .../{splits => dongle}/mermaid-connection.png | Bin docs/docs/features/{splits.mdx => dongle.mdx} | 10 +++++++--- docs/sidebars.js | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) rename docs/docs/assets/{splits => dongle}/mermaid-connection.png (100%) rename docs/docs/features/{splits.mdx => dongle.mdx} (96%) diff --git a/docs/docs/assets/splits/mermaid-connection.png b/docs/docs/assets/dongle/mermaid-connection.png similarity index 100% rename from docs/docs/assets/splits/mermaid-connection.png rename to docs/docs/assets/dongle/mermaid-connection.png diff --git a/docs/docs/features/splits.mdx b/docs/docs/features/dongle.mdx similarity index 96% rename from docs/docs/features/splits.mdx rename to docs/docs/features/dongle.mdx index 0de6e1a2..b4e351e3 100644 --- a/docs/docs/features/splits.mdx +++ b/docs/docs/features/dongle.mdx @@ -1,8 +1,12 @@ --- -title: Split boards with Dongles -sidebar_label: Split & Dongle +title: Keyboard Dongle +sidebar_label: Keyboard Dongle --- +:::warning +This implementation is experimental and subject to change. +::: + ZMK supports split keyboards that communicate wirelessly using BLE. Commonly these keyboards are split into two halves, each with its own microcontroller and battery. Usually the left half of the keyboard is given the split role of central, and the right half is given the split role of peripheral. The central half is responsible for communicating with the peripheral half and the host device. @@ -19,7 +23,7 @@ Dongles are usually connected to the host device using USB. This way the central and the peripheral halves can be powered by their own batteries. This setup allows both halves of the keyboard to have a longer battery life. -![Mermaid Connection](../assets/splits/mermaid-connection.png) +![Mermaid Connection](../assets/dongle/mermaid-connection.png) {/* Here is an example diagram of a split keyboard with a dongle: diff --git a/docs/sidebars.js b/docs/sidebars.js index 6835ce8b..aafc342b 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -44,7 +44,7 @@ module.exports = { "features/backlight", "features/battery", "features/soft-off", - "features/splits", + "features/dongle", ], }, {