Skip to content

Commit

Permalink
docs: fixed broken anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick-Munnich authored and caksoylar committed Sep 30, 2024
1 parent 99b424b commit e195822
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/docs/development/hardware-integration/new-shield.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ endif

In addition to the `Kconfig.shield` and `Kconfig.defconfig` files, many shields will also define a user configuration file called `my_keyboard.conf`.
This file exists to provide "suggestions" of [configuration settings](../../config/index.md) for a user to select, such as enabling deep sleep.
Note that the name should match the shield/part name defined in the [Kconfig.shield file](#Kconfig.shield).
Note that the name should match the shield/part name defined in the [Kconfig.shield file](#kconfigshield).

:::warning
This file can also be used to set configuration options.
Expand Down Expand Up @@ -243,7 +243,7 @@ There are three main things that need to be defined in this file:
<SplitInvisTabs>
<TabItem value="unibody">

A unibody keyboard will have a single overlay file named `my_keyboard.overlay`, where `my_keyboard` is the shield name defined in the [Kconfig.shield file](#Kconfig.shield).
A unibody keyboard will have a single overlay file named `my_keyboard.overlay`, where `my_keyboard` is the shield name defined in the [Kconfig.shield file](#kconfigshield).

</TabItem>
<TabItem value="split">
Expand All @@ -254,7 +254,7 @@ For example, if the keyboard is split into a left and a right half, these can be
- `my_keyboard_left.overlay`
- `my_keyboard_right.overlay`

Here `my_keyboard_left` and `my_keyboard_right` are the shield names defined in the [Kconfig.shield file](#Kconfig.shield).
Here `my_keyboard_left` and `my_keyboard_right` are the shield names defined in the [Kconfig.shield file](#kconfigshield).

Split keyboards often share some of their devicetree description.
The standard approach is to have a core `my_keyboard.dtsi` (devicetree include) file, which is included into each of the shield overlays.
Expand Down

0 comments on commit e195822

Please sign in to comment.