Browse Source

Flesh out documentation skeleton.

xmkb
Pete Johanson 4 years ago
parent
commit
e1ea833bb3
  1. 5
      docs/docs/behavior/key-press.md
  2. 7
      docs/docs/displays.md
  3. 7
      docs/docs/encoders.md
  4. 7
      docs/docs/keymaps.md
  5. 6
      docs/docs/underglow.md
  6. 2
      docs/sidebars.js

5
docs/docs/behavior/key-press.md

@ -0,0 +1,5 @@
---
title: Key Presses
---
TODO: Docs on key press behavior

7
docs/docs/displays.md

@ -0,0 +1,7 @@
---
id: displays
title: OLED Displays
sidebar_label: OLED Displays
---
TODO: Documentation on OLED displays.

7
docs/docs/encoders.md

@ -0,0 +1,7 @@
---
id: encoders
title: Encoders
sidebar_label: Encoders
---
TODO: Documentation on encoders.

7
docs/docs/keymaps.md

@ -0,0 +1,7 @@
---
id: keymaps
title: Keymaps & Behaviors
sidebar_label: Keymaps
---
Keymaps!

6
docs/docs/underglow.md

@ -0,0 +1,6 @@
---
id: underglow
title: RGB Underglow
---
TODO: Documentation on RGB underglow.

2
docs/sidebars.js

@ -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…
Cancel
Save