From 058d7f1b136ecd3ac8454631580be6e8eba95a8a Mon Sep 17 00:00:00 2001
From: Ally Parker <ally.parker@red-gate.com>
Date: Tue, 29 Dec 2020 13:50:17 +0000
Subject: [PATCH] Add Events page to development section. WIP

---
 docs/docs/development/events.md | 37 +++++++++++++++++++++++++++++++++
 docs/sidebars.js                |  1 +
 2 files changed, 38 insertions(+)
 create mode 100644 docs/docs/development/events.md

diff --git a/docs/docs/development/events.md b/docs/docs/development/events.md
new file mode 100644
index 00000000..392d93a6
--- /dev/null
+++ b/docs/docs/development/events.md
@@ -0,0 +1,37 @@
+---
+title: Events
+---
+## Overview
+ZMK uses events to decouple behaviours and to allow new functionality to be added to existing events.
+
+## `activity_state_changed`
+Fired by the activity monitor when the state changes. The monitor subscribes to `position_state_changed` and `sensor_event` events to keep track of activity.
+
+* `ZMK_ACTIVITY_ACTIVE` 
+* `ZMK_ACTIVITY_IDLE` - When idle time is greater than `CONFIG_ZMK_IDLE_TIMEOUT `
+* `ZMK_ACTIVITY_SLEEP` - When `CONFIG_ZMK_SLEEP` is enabled and idle time is greater than `CONFIG_ZMK_IDLE_SLEEP_TIMEOUT`
+
+## `battery_state_changed`
+todo
+
+## `ble_active_profile_changed`
+todo
+
+## `keycode_state_changed`
+todo
+
+## `layer_state_changed`
+todo
+
+## `modifiers_state_changed`
+todo
+
+## `position_state_changed`
+todo
+
+## `sensor_event`
+todo
+
+## `usb_conn_state_changed`
+todo
+
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 8fc1dc54..b7060edf 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -45,6 +45,7 @@ module.exports = {
       "development/posix-board",
       "development/tests",
       "development/usb-logging",
+      "development/events",
       {
         type: "category",
         label: "Guides",