From 2744f44e73436aff2c45d2bb9fa9883004b76ac9 Mon Sep 17 00:00:00 2001 From: innovaker <66737976+innovaker@users.noreply.github.com> Date: Thu, 12 Nov 2020 13:38:35 +0000 Subject: [PATCH] refactor(docs): Integrate `Dev Guides` into `Development` section Improves discoverability. --- .../development/{guide-new-shield.md => new-shield.md} | 0 docs/docs/features/encoders.md | 2 +- docs/docs/hardware.md | 2 +- docs/docs/user-setup.md | 2 +- docs/sidebars.js | 7 ++++++- 5 files changed, 9 insertions(+), 4 deletions(-) rename docs/docs/development/{guide-new-shield.md => new-shield.md} (100%) diff --git a/docs/docs/development/guide-new-shield.md b/docs/docs/development/new-shield.md similarity index 100% rename from docs/docs/development/guide-new-shield.md rename to docs/docs/development/new-shield.md diff --git a/docs/docs/features/encoders.md b/docs/docs/features/encoders.md index f962845b..01610775 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 2ad6c337..3c93313a 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 50074adb..4a842e41 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 82ab9751..7d124cc6 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"], }, };