From e1ea833bb3bff9401a5f205654f7149288897aa8 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Wed, 5 Aug 2020 14:04:08 -0400 Subject: [PATCH] Flesh out documentation skeleton. --- docs/docs/behavior/key-press.md | 5 +++++ docs/docs/displays.md | 7 +++++++ docs/docs/encoders.md | 7 +++++++ docs/docs/keymaps.md | 7 +++++++ docs/docs/underglow.md | 6 ++++++ docs/sidebars.js | 2 ++ 6 files changed, 34 insertions(+) create mode 100644 docs/docs/behavior/key-press.md create mode 100644 docs/docs/displays.md create mode 100644 docs/docs/encoders.md create mode 100644 docs/docs/keymaps.md create mode 100644 docs/docs/underglow.md diff --git a/docs/docs/behavior/key-press.md b/docs/docs/behavior/key-press.md new file mode 100644 index 00000000..8a69c4f8 --- /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 00000000..2339fe2f --- /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 00000000..c0ea4b66 --- /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 00000000..d54b1309 --- /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 00000000..ff1a236b --- /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 f6369a58..b270a68e 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",