Skip to content

Commit

Permalink
fix some links for docs dev
Browse files Browse the repository at this point in the history
  • Loading branch information
Univa committed Nov 28, 2023
1 parent 0702992 commit be0c6c0
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/src/content/docs/features/feature-backlight.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ struct MyKeyboard;
```

You will need to do additional setup for your selected storage driver as well.
For more information, see the docs for the [storage feature](../feature-storage).
For more information, see the docs for the [storage feature](../feature-storage/).
:::

If you're implementing a backlight matrix (either the `simple-backlight-matrix` or `rgb-backlight-matrix`), your keyboard must also implement the `BacklightMatrixDevice` trait:
Expand Down
3 changes: 1 addition & 2 deletions docs/src/content/docs/features/feature-bluetooth-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ impl BluetoothKeyboard for MyKeyboard {
You can use Bluetooth and USB host communication on the same keyboard.

If you are using a template, USB should already be configured, but if you manually
set up your Cargo workspace, then see the docs for
[USB host communication](../feature-usb-host).
set up your Cargo workspace, then see the docs for [USB host communication](../feature-usb-host/).

Also check the sections below for more information.
:::
Expand Down
8 changes: 4 additions & 4 deletions docs/src/content/docs/features/feature-split.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ impl NRFBLECentralDevice for MyKeyboardLeftHalf {

:::note
In case you are using the `ble` driver, if your keyboard also communicates with your host device using Bluetooth
(basically if you followed the [Bluetooth doc](../feature-bluetooth-host) or chose a template with Bluetooth),
(basically if you followed the [Bluetooth doc](../feature-bluetooth-host/) or chose a template with Bluetooth),
then the `BluetoothDevice` trait should already be implemented for you.
:::

:::caution
Make sure your central device communicates with a host device over [USB](../feature-usb-host)
or [Bluetooth](../feature-bluetooth-host). Please follow those documents to implement
Make sure your central device communicates with a host device over [USB](../feature-usb-host/)
or [Bluetooth](../feature-bluetooth-host/). Please follow those documents to implement
your desired functionality.

Although it is possible to compile a central device without them, your keyboard won't
Expand Down Expand Up @@ -153,7 +153,7 @@ For a peripheral device, you do not have to implement `KeyboardLayout`. Only `Ke

:::note
In case you are using the `ble` driver, if your keyboard also communicates with your host device using Bluetooth
(basically if you followed the [Bluetooth doc](../feature-bluetooth-host) or chose a template with Bluetooth),
(basically if you followed the [Bluetooth doc](../feature-bluetooth-host/) or chose a template with Bluetooth),
then the `BluetoothDevice` trait should already be implemented for you.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/features/feature-underglow.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ impl UnderglowDevice for MyKeyboard {
```

You will need to do additional setup for your selected storage driver as well.
For more information, see the docs for the [storage feature](../feature-storage).
For more information, see the docs for the [storage feature](../feature-storage/).
:::

Lastly, you must also implement the appropriate trait that corresponds to your chosen driver in the `#[keyboard]` macro. For example, with `ws2812_bitbang`, you must implement `WS2812BitbangUnderglowDriver`:
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/features/feature-via-vial.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ impl ViaKeyboard for MyKeyboard {
```

You will need to do additional setup for your selected storage driver as well.
For more information, see the docs for the [storage feature](../feature-storage).
For more information, see the docs for the [storage feature](../feature-storage/).
:::

If you are using Vial, you must also implement `VialKeyboard` in addition to `ViaKeyboard`.
Expand Down Expand Up @@ -415,7 +415,7 @@ No menu for RGB matrix is provided. RGB backlight animations still need to be im
- Lighting keycodes, except for `QK_BACKLIGHT_TOGGLE_BREATHING`. RGB keycodes only work for underglow, not an RGB backlight matrix.
- Momentary layers, and default layers (MO(x) and DF(x))
- Custom keycodes (`customKeycodes` in your JSON definition)
- Certain media keycodes. Support for this must be enabled manually. Check the ["Media Keys" doc](../feature-media-keys)
- Certain media keycodes. Support for this must be enabled manually. Check the ["Media Keys" doc](../feature-media-keys/)
- QK_OUTPUT_BLUETOOTH and QK_OUTPUT_USB

Attempts to use unsupported keycodes will not result in any changes to your layout. It may show in the app, but reloading will revert the keycodes back to their previous state.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/getting-started/matrix-and-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ implementations in the same entrypoint. If you are using a split keyboard, you c
implement the `KeyboardMatrix` and `KeyboardLayout` traits, but the placement of the `impl` blocks will depend
on your split keyboard setup.

See the [split keyboard document](../../features/feature-split) for more information.
See the [split keyboard document](../../features/feature-split/) for more information.
:::

# Keyboard Information
Expand Down

0 comments on commit be0c6c0

Please sign in to comment.