summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody McGinnis <brainwart@gmail.com>2020-08-19 00:07:08 -0400
committerCody McGinnis <brainwart@gmail.com>2020-08-19 00:07:08 -0400
commitfeadfc93dc5cae23afbca1cfeb6433463aee4b43 (patch)
tree51d769871a551bd1e196daf5003a0f92f9f8bfbb
parent0d3cfa859636a43e77ebad66f048452320d65d8b (diff)
feat(docs): create a bond clearing page
-rw-r--r--docs/docs/assets/bond-clearing/corne.jpgbin0 -> 147244 bytes
-rw-r--r--docs/docs/assets/bond-clearing/kyria.jpgbin0 -> 140236 bytes
-rw-r--r--docs/docs/bond-reset.md26
-rw-r--r--docs/sidebars.js2
4 files changed, 27 insertions, 1 deletions
diff --git a/docs/docs/assets/bond-clearing/corne.jpg b/docs/docs/assets/bond-clearing/corne.jpg
new file mode 100644
index 0000000..1e070a2
--- /dev/null
+++ b/docs/docs/assets/bond-clearing/corne.jpg
Binary files differ
diff --git a/docs/docs/assets/bond-clearing/kyria.jpg b/docs/docs/assets/bond-clearing/kyria.jpg
new file mode 100644
index 0000000..9fa22a0
--- /dev/null
+++ b/docs/docs/assets/bond-clearing/kyria.jpg
Binary files differ
diff --git a/docs/docs/bond-reset.md b/docs/docs/bond-reset.md
new file mode 100644
index 0000000..03d6dd1
--- /dev/null
+++ b/docs/docs/bond-reset.md
@@ -0,0 +1,26 @@
+---
+id: bond-reset
+title: Reset BLE Connections
+sidebar_label: BLE Reset
+---
+
+Known as a 'bond reset', a special key combination, that is not related to the user defined key map, which
+clears all wireless connection configurations.
+
+:::warning
+Currently, ZMK only supports a single BLE host. If you remove the keyboard from the host's bluetooth devices
+list, you will need to clear the bonds.
+:::
+
+### Split Keyboards
+
+Split keyboards will need to be cleared on both halves. For best results try to reset them at the same time.
+
+
+## Kyria
+
+![Kyria bond-reset combo](assets/bond-clearing/kyria.jpg)
+
+## Corne
+
+![Corne bond-reset combo](assets/bond-clearing/corne.jpg) \ No newline at end of file
diff --git a/docs/sidebars.js b/docs/sidebars.js
index be02a65..8c7c97f 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -1,6 +1,6 @@
module.exports = {
someSidebar: {
- "Getting Started": ["intro", "hardware", "faq", "user-setup"],
+ "Getting Started": ["intro", "hardware", "faq", "user-setup", "bond-reset"],
Features: [
"feature/keymaps",
"feature/displays",