refactor(docs): Integrate Dev Guides
into Development
section
Improves discoverability.
This commit is contained in:
parent
2d50302a02
commit
2744f44e73
5 changed files with 9 additions and 4 deletions
|
@ -41,4 +41,4 @@ Here, the left encoder is configured to control volume up and down while the rig
|
||||||
|
|
||||||
## Adding Encoder Support
|
## 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.
|
||||||
|
|
|
@ -47,4 +47,4 @@ Until detailed documentation is available, feel free to ask questions about how
|
||||||
|
|
||||||
## Contributing
|
## 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.
|
||||||
|
|
|
@ -105,7 +105,7 @@ Pick an MCU board:
|
||||||
:::note
|
:::note
|
||||||
If you are building firmware for a new keyboard shield that is not included in the built-in
|
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,
|
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:
|
When prompted, enter the number for the corresponding keyboard shield you would like to target:
|
||||||
|
|
|
@ -44,7 +44,12 @@ module.exports = {
|
||||||
"development/posix-board",
|
"development/posix-board",
|
||||||
"development/tests",
|
"development/tests",
|
||||||
"development/usb-logging",
|
"development/usb-logging",
|
||||||
|
{
|
||||||
|
type: "category",
|
||||||
|
label: "Guides",
|
||||||
|
collapsed: false,
|
||||||
|
items: ["development/new-shield"],
|
||||||
|
},
|
||||||
],
|
],
|
||||||
"Dev Guides": ["development/guide-new-shield"],
|
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in a new issue