From d63d6b8409368bdebfcc6ad7e7271c3ebb796d61 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Mon, 8 Jun 2020 22:45:34 -0700
Subject: [PATCH] migrate led plugin overview from wiki

---
 docs/index.rst         |  8 ++++++++
 docs/overviews/leds.md | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 docs/overviews/leds.md

diff --git a/docs/index.rst b/docs/index.rst
index 96416f8b..787e49aa 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -34,6 +34,14 @@ Supported input devices
 
    hardware-devices/*
 
+Topic overviews
+----------------
+.. toctree::
+   :maxdepth: 1
+   :glob: 
+
+   overviews/*
+
 Plugins 
 -------
 .. toctree::
diff --git a/docs/overviews/leds.md b/docs/overviews/leds.md
new file mode 100644
index 00000000..7f36858b
--- /dev/null
+++ b/docs/overviews/leds.md
@@ -0,0 +1,37 @@
+# Core LED Effects
+
+
+This is the list of the stable LED effects in the core libraries.
+
+<h4>LED-ActiveModColor</h4>
+
+A very simple plugin, that lights up the LED in white under any active modifier, for the duration of its activity. Also supports one-shots.
+
+<h4>Kaleidoscope-LEDEffects</h4>
+
+The LEDEffects plugin provides a selection of LED effects, each of them fairly simple, simple enough to not need a plugin of their own. There are a number of different effects included in the package, all of them are available once including the header, and one's free to choose any number of them. 
+<h4>Kaleidoscope-LEDEffect-BootGreeting</h4>
+
+If you want to have your keyboard signal when it turns on, but you don't want to use any more complicated LED modes, this plugin is for you. It will make the ``LEDEffectNext`` key on your keymap slowly breathe for about ten seconds after plugging the keyboard in (without blocking the normal functionality of the keyboard, of course).
+
+<h4>Kaleidoscope-LEDEffect-Breathe</h4>
+
+Provides a breathing effect for the keyboard. Breathe in, breathe out.
+
+<h4>Kaleidoscope-LEDEffect-Chase</h4>
+
+A simple LED effect where one color chases another across the keyboard and back, over and over again. Playful colors they are.
+
+<h4>Kaleidoscope-LEDEffect-Rainbow</h4>
+
+Two colorful rainbow effects are implemented by this plugin: one where the rainbow waves through the keys, and another where the LEDs breathe though the colors of a rainbow. The difference is that in the first case, we have all the rainbow colors on display, and it waves through the keyboard. In the second case, we have only one color at a time, for the whole board, and the color cycles through the rainbow's palette.
+
+<h4>Kaleidoscope-LEDEffect-SolidColor</h4>
+
+This plugin provides tools to build LED effects that set the entire keyboard to a single color. For show, and for backlighting purposes.
+
+<h4>LED-Stalker</h4>
+
+Demoed in the backer update, this adds an effect that stalks your keys: whenever a key is pressed, the LED under it lights up, and the slowly fades away once the key is released. This provides a kind of trailing effect.
+
+There are two color schemes currently: Haunt, which is a white-ish, ghostly color that follows your fingers, and BlazingTrail, demoed in the video, which lights your keyboard on fire. It looks much better in real life.