Flesh out documentation skeleton.
This commit is contained in:
parent
db586b1ce0
commit
e1ea833bb3
6 changed files with 34 additions and 0 deletions
5
docs/docs/behavior/key-press.md
Normal file
5
docs/docs/behavior/key-press.md
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
title: Key Presses
|
||||||
|
---
|
||||||
|
|
||||||
|
TODO: Docs on key press behavior
|
7
docs/docs/displays.md
Normal file
7
docs/docs/displays.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
id: displays
|
||||||
|
title: OLED Displays
|
||||||
|
sidebar_label: OLED Displays
|
||||||
|
---
|
||||||
|
|
||||||
|
TODO: Documentation on OLED displays.
|
7
docs/docs/encoders.md
Normal file
7
docs/docs/encoders.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
id: encoders
|
||||||
|
title: Encoders
|
||||||
|
sidebar_label: Encoders
|
||||||
|
---
|
||||||
|
|
||||||
|
TODO: Documentation on encoders.
|
7
docs/docs/keymaps.md
Normal file
7
docs/docs/keymaps.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
id: keymaps
|
||||||
|
title: Keymaps & Behaviors
|
||||||
|
sidebar_label: Keymaps
|
||||||
|
---
|
||||||
|
|
||||||
|
Keymaps!
|
6
docs/docs/underglow.md
Normal file
6
docs/docs/underglow.md
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
---
|
||||||
|
id: underglow
|
||||||
|
title: RGB Underglow
|
||||||
|
---
|
||||||
|
|
||||||
|
TODO: Documentation on RGB underglow.
|
|
@ -1,6 +1,8 @@
|
||||||
module.exports = {
|
module.exports = {
|
||||||
someSidebar: {
|
someSidebar: {
|
||||||
"Getting Started": ["intro", "hardware", "user-setup", "faq"],
|
"Getting Started": ["intro", "hardware", "user-setup", "faq"],
|
||||||
|
Features: ["keymaps", "displays", "encoders", "underglow"],
|
||||||
|
Behaviors: ["behavior/key-press"],
|
||||||
Development: [
|
Development: [
|
||||||
"dev-clean-room",
|
"dev-clean-room",
|
||||||
"dev-setup",
|
"dev-setup",
|
||||||
|
|
Loading…
Reference in a new issue