summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-08-05 14:04:08 -0400
committerPete Johanson <peter@peterjohanson.com>2020-08-05 14:04:08 -0400
commite1ea833bb3bff9401a5f205654f7149288897aa8 (patch)
treef12ab969a30a470052da50034f2e5e0d29deeb87
parentdb586b1ce08b7ec286147c54896e3a42b56b94af (diff)
Flesh out documentation skeleton.
-rw-r--r--docs/docs/behavior/key-press.md5
-rw-r--r--docs/docs/displays.md7
-rw-r--r--docs/docs/encoders.md7
-rw-r--r--docs/docs/keymaps.md7
-rw-r--r--docs/docs/underglow.md6
-rw-r--r--docs/sidebars.js2
6 files changed, 34 insertions, 0 deletions
diff --git a/docs/docs/behavior/key-press.md b/docs/docs/behavior/key-press.md
new file mode 100644
index 0000000..8a69c4f
--- /dev/null
+++ b/docs/docs/behavior/key-press.md
@@ -0,0 +1,5 @@
+---
+title: Key Presses
+---
+
+TODO: Docs on key press behavior
diff --git a/docs/docs/displays.md b/docs/docs/displays.md
new file mode 100644
index 0000000..2339fe2
--- /dev/null
+++ b/docs/docs/displays.md
@@ -0,0 +1,7 @@
+---
+id: displays
+title: OLED Displays
+sidebar_label: OLED Displays
+---
+
+TODO: Documentation on OLED displays.
diff --git a/docs/docs/encoders.md b/docs/docs/encoders.md
new file mode 100644
index 0000000..c0ea4b6
--- /dev/null
+++ b/docs/docs/encoders.md
@@ -0,0 +1,7 @@
+---
+id: encoders
+title: Encoders
+sidebar_label: Encoders
+---
+
+TODO: Documentation on encoders.
diff --git a/docs/docs/keymaps.md b/docs/docs/keymaps.md
new file mode 100644
index 0000000..d54b130
--- /dev/null
+++ b/docs/docs/keymaps.md
@@ -0,0 +1,7 @@
+---
+id: keymaps
+title: Keymaps & Behaviors
+sidebar_label: Keymaps
+---
+
+Keymaps!
diff --git a/docs/docs/underglow.md b/docs/docs/underglow.md
new file mode 100644
index 0000000..ff1a236
--- /dev/null
+++ b/docs/docs/underglow.md
@@ -0,0 +1,6 @@
+---
+id: underglow
+title: RGB Underglow
+---
+
+TODO: Documentation on RGB underglow.
diff --git a/docs/sidebars.js b/docs/sidebars.js
index f6369a5..b270a68 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -1,6 +1,8 @@
module.exports = {
someSidebar: {
"Getting Started": ["intro", "hardware", "user-setup", "faq"],
+ Features: ["keymaps", "displays", "encoders", "underglow"],
+ Behaviors: ["behavior/key-press"],
Development: [
"dev-clean-room",
"dev-setup",