From 805ea770053269278fe0ed443b68f600021d82d1 Mon Sep 17 00:00:00 2001
From: Pete Johanson <peter@peterjohanson.com>
Date: Fri, 21 Aug 2020 00:33:48 -0400
Subject: feat(behaviors): Add `&bootloader` behavior.

* Allow reset behavior to have a type property.
* Add `bootloader` node that triggers DFU UF2
  bootloader mode using the AdaFruit nrf52
  bootloader.
---
 docs/docs/behavior/reset.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 docs/sidebars.js            |  1 +
 2 files changed, 44 insertions(+)
 create mode 100644 docs/docs/behavior/reset.md

(limited to 'docs')

diff --git a/docs/docs/behavior/reset.md b/docs/docs/behavior/reset.md
new file mode 100644
index 0000000..8cf122b
--- /dev/null
+++ b/docs/docs/behavior/reset.md
@@ -0,0 +1,43 @@
+---
+title: Reset Behaviors
+sidebar_label: Reset
+---
+
+## Summary
+
+There are two available behaviors that can be used to trigger a reset of the keyboard.
+The first is a soft reset, that will simply reset and re-run the currently flashed
+firmware; the second when triggered will reset into the bootloader, allowing you to
+flash a new firmware to the keyboard.
+
+## Reset
+
+The basic reset behavior will reset the keyboard and re-run the firmware flashed
+to the device
+
+### Behavior Binding
+
+- Reference: `&reset`
+- Parameters: None
+
+Example:
+
+```
+&reset
+```
+
+## Bootloader Reset
+
+The bootloader reset behavior will reset the keyboard and put it into bootloader mode, allowing
+you to flash a new firmware.
+
+### Behavior Binding
+
+- Reference: `&bootloader`
+- Parameters: None
+
+Example:
+
+```
+&bootloader
+```
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 8c7c97f..51313fc 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -12,6 +12,7 @@ module.exports = {
       "behavior/layers",
       "behavior/misc",
       "behavior/mod-tap",
+      "behavior/reset",
       "behavior/lighting",
     ],
     Development: [
-- 
cgit v1.2.3