From f15caa2a8797f5675430c9d3ddd6513ed3b93af1 Mon Sep 17 00:00:00 2001 From: David Madison Date: Thu, 6 Jun 2024 16:06:13 -0400 Subject: [PATCH] Add label ID to supported devices doc page The generated name mysteriously changed on the generated GitHub documentation. This label should keep it in one place. --- README.md | 2 +- docs/pages/supported_devices.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7834aa7..f6933ef 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The [Sim Racing Library](https://github.com/dmadison/Sim-Racing-Arduino/) is an Install the library using either [the .zip file from the latest release](https://github.com/dmadison/Sim-Racing-Arduino/releases/latest/) or by searching for "Sim Racing" in the libraries manager of the Arduino IDE. [See the Arduino documentation on how to install libraries for more information.](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries) -[Read the documentation](http://dmadison.github.io/Sim-Racing-Arduino/docs/md_pages_supported_devices.html) to check if your device is supported by the library. Follow the wiring instructions on the device page to connect your device to the Arduino. +[Read the documentation](http://dmadison.github.io/Sim-Racing-Arduino/docs/supported_devices.html) to check if your device is supported by the library. Follow the wiring instructions on the device page to connect your device to the Arduino. Run one of the library examples in the Arduino IDE by going to `File -> Examples -> Sim Racing Library`. For all peripherals, call `begin()` to initialize the class and `update()` to refresh with new data. diff --git a/docs/pages/supported_devices.md b/docs/pages/supported_devices.md index 9a40dee..0761f5a 100644 --- a/docs/pages/supported_devices.md +++ b/docs/pages/supported_devices.md @@ -1,4 +1,4 @@ -# Supported Devices +# Supported Devices {#supported_devices} ### Generic Devices