Browse Source

refactor(docs): Integrate `Dev Guides` into `Development` section

Improves discoverability.
xmkb
innovaker 4 years ago committed by Pete Johanson
parent
commit
2744f44e73
  1. 0
      docs/docs/development/new-shield.md
  2. 2
      docs/docs/features/encoders.md
  3. 2
      docs/docs/hardware.md
  4. 2
      docs/docs/user-setup.md
  5. 7
      docs/sidebars.js

0
docs/docs/development/guide-new-shield.md → docs/docs/development/new-shield.md

2
docs/docs/features/encoders.md

@ -41,4 +41,4 @@ Here, the left encoder is configured to control volume up and down while the rig @@ -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.

2
docs/docs/hardware.md

@ -47,4 +47,4 @@ Until detailed documentation is available, feel free to ask questions about how @@ -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.

2
docs/docs/user-setup.md

@ -105,7 +105,7 @@ Pick an MCU board: @@ -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:

7
docs/sidebars.js

@ -44,7 +44,12 @@ module.exports = { @@ -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"],
},
};

Loading…
Cancel
Save