summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorinnovaker <66737976+innovaker@users.noreply.github.com>2020-11-12 13:38:35 +0000
committerPete Johanson <peter@peterjohanson.com>2020-11-20 22:31:56 -0500
commit2744f44e73436aff2c45d2bb9fa9883004b76ac9 (patch)
tree252fd6a5f6a78c13750992ea54311e41953a0351 /docs
parent2d50302a027797b3e1be91c93e148c5f44c753fb (diff)
refactor(docs): Integrate `Dev Guides` into `Development` section
Improves discoverability.
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/development/new-shield.md (renamed from docs/docs/development/guide-new-shield.md)0
-rw-r--r--docs/docs/features/encoders.md2
-rw-r--r--docs/docs/hardware.md2
-rw-r--r--docs/docs/user-setup.md2
-rw-r--r--docs/sidebars.js7
5 files changed, 9 insertions, 4 deletions
diff --git a/docs/docs/development/guide-new-shield.md b/docs/docs/development/new-shield.md
index 306f1b3..306f1b3 100644
--- a/docs/docs/development/guide-new-shield.md
+++ b/docs/docs/development/new-shield.md
diff --git a/docs/docs/features/encoders.md b/docs/docs/features/encoders.md
index f962845..0161077 100644
--- a/docs/docs/features/encoders.md
+++ b/docs/docs/features/encoders.md
@@ -41,4 +41,4 @@ Here, the left encoder is configured to control volume up and down while the rig
## Adding Encoder Support
-See the [New Keyboard Shield](../development/guide-new-shield#encoders) documentation for how to add or modify additional encoders to your shield.
+See the [New Keyboard Shield](../development/new-shield#encoders) documentation for how to add or modify additional encoders to your shield.
diff --git a/docs/docs/hardware.md b/docs/docs/hardware.md
index 2ad6c33..3c93313 100644
--- a/docs/docs/hardware.md
+++ b/docs/docs/hardware.md
@@ -47,4 +47,4 @@ Until detailed documentation is available, feel free to ask questions about how
## Contributing
-If you'd like to add support for a new keyboard shield, head over to the [New Keyboard Shield](development/guide-new-shield) documentation.
+If you'd like to add support for a new keyboard shield, head over to the [New Keyboard Shield](development/new-shield) documentation.
diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md
index 50074ad..4a842e4 100644
--- a/docs/docs/user-setup.md
+++ b/docs/docs/user-setup.md
@@ -105,7 +105,7 @@ Pick an MCU board:
:::note
If you are building firmware for a new keyboard shield that is not included in the built-in
list of shields, you can choose any shield from the list that is similar to yours to generate the repository,
-and edit / add necessary files according to the [guide for adding new keyboard shield](./development/guide-new-shield).
+and edit / add necessary files according to the [guide for adding new keyboard shield](./development/new-shield).
:::
When prompted, enter the number for the corresponding keyboard shield you would like to target:
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 82ab975..7d124cc 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -44,7 +44,12 @@ module.exports = {
"development/posix-board",
"development/tests",
"development/usb-logging",
+ {
+ type: "category",
+ label: "Guides",
+ collapsed: false,
+ items: ["development/new-shield"],
+ },
],
- "Dev Guides": ["development/guide-new-shield"],
},
};