DOCS-1501: Align capitalization of component pages (#2317)

viamrobotics · Dec 12, 2023 · 1abda09 · 1abda09
1 parent 227e81e
commit 1abda09
Show file tree

Hide file tree

Showing 53 changed files with 75 additions and 71 deletions.
diff --git a/docs/components/arm/eva.md b/docs/components/arm/eva.md
@@ -1,10 +1,10 @@
 ---
-title: "Configure an eva Arm"
+title: "Configure an Eva Arm"
 linkTitle: "eva"
 weight: 34
 type: "docs"
 draft: "true"
-description: "Configure an eva arm."
+description: "Configure an Eva arm."
 images: ["/icons/components/arm.svg"]
 tags: ["arm", "components"]
 aliases:

diff --git a/docs/components/arm/ur5e.md b/docs/components/arm/ur5e.md
@@ -1,9 +1,9 @@
 ---
-title: "Configure a ur5e Arm"
+title: "Configure a UR5e Arm"
 linkTitle: "ur5e"
 weight: 40
 type: "docs"
-description: "Configure a ur5e arm."
+description: "Configure a UR5e arm."
 images: ["/icons/components/arm.svg"]
 tags: ["arm", "components"]
 aliases:

diff --git a/docs/components/arm/yahboom-dofbot.md b/docs/components/arm/yahboom-dofbot.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a yahboom-dofbot Arm"
+title: "Configure a Yahboom DOFBOT Arm"
 linkTitle: "yahboom-dofbot"
 weight: 50
 type: "docs"

diff --git a/docs/components/board/beaglebone.md b/docs/components/board/beaglebone.md
@@ -1,9 +1,9 @@
 ---
-title: "Configure a beaglebone board"
+title: "Configure a BeagleBone Board"
 linkTitle: "beaglebone"
 weight: 40
 type: "docs"
-description: "Configure a beaglebone board."
+description: "Configure a BeagleBone board."
 images: ["/icons/components/board.svg"]
 tags: ["board", "components"]
 aliases:

diff --git a/docs/components/board/customlinux.md b/docs/components/board/customlinux.md
@@ -1,9 +1,9 @@
 ---
-title: "Configure a customlinux board"
+title: "Configure a Custom Linux Board"
 linkTitle: "customlinux"
 weight: 75
 type: "docs"
-description: "Configure a customlinux board."
+description: "Configure a custom Linux board."
 images: ["/icons/components/board.svg"]
 tags: ["board", "components"]
 aliases:

diff --git a/docs/components/board/fake.md b/docs/components/board/fake.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a fake board"
+title: "Configure a Fake Board"
 linkTitle: "fake"
 weight: 20
 type: "docs"

diff --git a/docs/components/board/jetson.md b/docs/components/board/jetson.md
@@ -1,9 +1,9 @@
 ---
-title: "Configure a jetson board"
+title: "Configure a Jetson Board"
 linkTitle: "jetson"
 weight: 20
 type: "docs"
-description: "Configure a jetson board to integrate a NVIDIA Jetson Orin Module and Developer Kit, NVIDIA Jetson AGX, or NVIDIA Jetson Nano into your robot."
+description: "Configure a jetson board to integrate an NVIDIA Jetson Orin Module and Developer Kit, NVIDIA Jetson AGX, or NVIDIA Jetson Nano into your robot."
 images: ["/icons/components/board.svg"]
 tags: ["board", "components"]
 aliases:
@@ -19,23 +19,27 @@ If you have a CSI camera, follow [these instructions](https://github.com/viamrob
 
 {{% /alert %}}
 
-{{% alert title="CAUTION: Use 3.3V inputs and outputs" color="caution" %}}
+{{% alert title="CAUTION" color="caution" %}}
 
-The GPIO pins on Jetson boards are rated 3.3V signals. 5V signals from encoders and sensors can cause damage to a pin. We recommend selecting hardware that can operate 3.3V signals or lower. For details, see your boards specification. For the Jetson Nano, see pages 1-3 of the [Jetson Nano Developer Kit 40-Pin Expansion Header GPIO Usage Considerations Applications Note](https://developer.nvidia.com/jetson-nano-developer-kit-40-pin-expansion-header-gpio-usage-considerations-applications-note).
+The GPIO pins on Jetson boards are rated for 3.3V signals.
+5V signals from encoders and sensors can cause damage to a pin.
+We recommend selecting hardware that can operate 3.3V signals or lower.
+For details, see your board's specification.
+For the Jetson Nano, see pages 1-3 of the [Jetson Nano Developer Kit 40-Pin Expansion Header GPIO Usage Considerations Applications Note](https://developer.nvidia.com/jetson-nano-developer-kit-40-pin-expansion-header-gpio-usage-considerations-applications-note).
 
 {{% /alert %}}
 
-Configure a `jetson` board to integrate a [NVIDIA Jetson Orin Module and Developer Kit](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-orin/), [NVIDIA Jetson AGX](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-agx-xavier/), or [NVIDIA Jetson Nano](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-nano/) into your robot:
+Configure a `jetson` board to integrate an [NVIDIA Jetson Orin Module and Developer Kit](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-orin/), [NVIDIA Jetson AGX](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-agx-xavier/), or [NVIDIA Jetson Nano](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-nano/) into your robot:
 
-{{< tabs name="Configure an jetson Board" >}}
+{{< tabs >}}
 {{% tab name="Config Builder" %}}
 
 Navigate to the **Config** tab of your robot's page in [the Viam app](https://app.viam.com).
 Click on the **Components** subtab and click **Create component**.
 Select the `board` type, then select the `jetson` model.
 Enter a name for your board and click **Create**.
 
-![An example configuration for a jetson board in the Viam app Config Builder.](/components/board/jetson-ui-config.png)
+![An example configuration for a Jetson board in the Viam app Config Builder.](/components/board/jetson-ui-config.png)
 
 {{< readfile "/static/include/components/board-attr-config.md" >}}
 

diff --git a/docs/components/board/numato.md b/docs/components/board/numato.md
@@ -1,9 +1,9 @@
 ---
-title: "Configure a numato board"
+title: "Configure a Numato Board"
 linkTitle: "numato"
 weight: 50
 type: "docs"
-description: "Configure a numato board."
+description: "Configure a Numato peripheral board."
 images: ["/icons/components/board.svg"]
 tags: ["board", "components"]
 aliases:

diff --git a/docs/components/board/pca9685.md b/docs/components/board/pca9685.md
@@ -1,9 +1,9 @@
 ---
-title: "Configure a pca9685 board"
+title: "Configure a PCA9685 Board"
 linkTitle: "pca9685"
 weight: 70
 type: "docs"
-description: "Configure a pca9685 board."
+description: "Configure a PCA9685 board."
 images: ["/icons/components/board.svg"]
 tags: ["board", "components"]
 aliases:

diff --git a/docs/components/board/pi.md b/docs/components/board/pi.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a Raspberry Pi 4, 3, or Zero 2 W board"
+title: "Configure a Raspberry Pi 4, 3, or Zero 2 W Board"
 linkTitle: "pi"
 weight: 20
 type: "docs"

diff --git a/docs/components/board/pi5.md b/docs/components/board/pi5.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a Raspberry Pi 5 board"
+title: "Configure a Raspberry Pi 5 Board"
 linkTitle: "pi5"
 weight: 20
 type: "docs"

diff --git a/docs/components/board/ti.md b/docs/components/board/ti.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a ti board"
+title: "Configure a TI Board"
 linkTitle: "ti"
 weight: 20
 type: "docs"

diff --git a/docs/components/board/upboard.md b/docs/components/board/upboard.md
@@ -1,17 +1,17 @@
 ---
-title: "Configure an upboard board"
+title: "Configure an UP Board"
 linkTitle: "upboard"
 weight: 70
 type: "docs"
-description: "Configure an upboard board."
+description: "Configure an UP board."
 images: ["/icons/components/board.svg"]
 tags: ["board", "components"]
 aliases:
   - "/components/board/upboard/"
 # SMEs: Susmita
 ---
 
-Configure an `upboard` board to integrate an Intel-based board like the [UP4000](https://github.com/up-board/up-community/wiki/Pinout_UP4000) into your robot.
+Configure an `upboard` board to integrate an Intel-based board like the [UP 4000](https://github.com/up-board/up-community/wiki/Pinout_UP4000) into your robot.
 
 Complete the following setup requirements, then move on to configuring your board in [the Viam app](https://app.viam.com):
 

diff --git a/docs/components/camera/rtsp.md b/docs/components/camera/rtsp.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an RTSP camera"
+title: "Configure an RTSP Camera"
 linkTitle: "rtsp"
 weight: 34
 type: "docs"

diff --git a/docs/components/camera/ultrasonic.md b/docs/components/camera/ultrasonic.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an ultrasonic Camera"
+title: "Configure an Ultrasonic Camera"
 linkTitle: "ultrasonic"
 weight: 60
 type: "docs"

diff --git a/docs/components/encoder/ams-as5048.md b/docs/components/encoder/ams-as5048.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an AMS-AS5048 encoder"
+title: "Configure an AMS-AS5048 Encoder"
 linkTitle: "AMS-AS5048"
 type: "docs"
 description: "Configure an AMS-AS5048 encoder."

diff --git a/docs/components/encoder/arduino.md b/docs/components/encoder/arduino.md
@@ -1,8 +1,8 @@
 ---
-title: "Configure an arduino encoder"
+title: "Configure an Arduino Encoder"
 linkTitle: "arduino"
 type: "docs"
-description: "Configure an arduino encoder."
+description: "Configure an Arduino encoder."
 images: ["/icons/components/encoder.svg"]
 tags: ["encoder", "components"]
 draft: true

diff --git a/docs/components/encoder/fake.md b/docs/components/encoder/fake.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a fake encoder"
+title: "Configure a Fake Encoder"
 linkTitle: "fake"
 type: "docs"
 description: "Configure a fake encoder."

diff --git a/docs/components/encoder/incremental.md b/docs/components/encoder/incremental.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an incremental encoder"
+title: "Configure an Incremental Encoder"
 linkTitle: "incremental"
 type: "docs"
 description: "Configure an incremental encoder."

diff --git a/docs/components/encoder/single.md b/docs/components/encoder/single.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a single encoder"
+title: "Configure a Single Encoder"
 linkTitle: "single"
 type: "docs"
 description: "Configure a single encoder."

diff --git a/docs/components/gantry/fake.md b/docs/components/gantry/fake.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a fake Gantry"
+title: "Configure a Fake Gantry"
 linkTitle: "fake"
 weight: 10
 type: "docs"

diff --git a/docs/components/gripper/fake.md b/docs/components/gripper/fake.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a fake Gripper"
+title: "Configure a Fake Gripper"
 linkTitle: "fake"
 weight: 10
 type: "docs"

diff --git a/docs/components/input-controller/fake.md b/docs/components/input-controller/fake.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a fake input controller for testing"
+title: "Configure a Fake Input Controller for Testing"
 linkTitle: "fake"
 weight: 30
 type: "docs"

diff --git a/docs/components/input-controller/gamepad.md b/docs/components/input-controller/gamepad.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a Linux-supported gamepad"
+title: "Configure a Linux-supported Gamepad"
 linkTitle: "gamepad"
 weight: 30
 type: "docs"

diff --git a/docs/components/input-controller/gpio.md b/docs/components/input-controller/gpio.md
@@ -1,9 +1,9 @@
 ---
-title: "Configure a GPIO/ADC-based input controller"
+title: "Configure a GPIO/ADC-Based Input Controller"
 linkTitle: "gpio"
 weight: 30
 type: "docs"
-description: "Configure a GPIO or ADC based device as an input controller."
+description: "Configure a GPIO- or ADC-based device as an input controller."
 images: ["/icons/components/controller.svg"]
 tags: ["input controller", "components"]
 aliases:

diff --git a/docs/components/input-controller/mux.md b/docs/components/input-controller/mux.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a mux input controller"
+title: "Configure a Mux Input Controller"
 linkTitle: "mux"
 weight: 30
 type: "docs"

diff --git a/docs/components/input-controller/webgamepad.md b/docs/components/input-controller/webgamepad.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a webgamepad"
+title: "Configure a Web Gamepad"
 linkTitle: "webgamepad"
 weight: 30
 type: "docs"

diff --git a/docs/components/motor/28byj48.md b/docs/components/motor/28byj48.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a 28byj48 stepper motor"
+title: "Configure a 28BYJ-48 Stepper Motor"
 linkTitle: "28byj48"
 weight: 22
 type: "docs"

diff --git a/docs/components/motor/dmc4000.md b/docs/components/motor/dmc4000.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a DMC4000 motor"
+title: "Configure a DMC4000-Controlled Motor"
 linkTitle: "DMC4000"
 weight: 60
 type: "docs"

diff --git a/docs/components/motor/fake.md b/docs/components/motor/fake.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a fake motor"
+title: "Configure a Fake Motor"
 linkTitle: "fake"
 weight: 10
 type: "docs"

diff --git a/docs/components/motor/gpio/_index.md b/docs/components/motor/gpio/_index.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a gpio motor"
+title: "Configure a GPIO-Controlled Motor"
 linkTitle: "gpio"
 weight: 10
 type: "docs"

diff --git a/docs/components/motor/gpio/encoded-motor.md b/docs/components/motor/gpio/encoded-motor.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a motor with an encoder"
+title: "Configure a Motor with an Encoder"
 linkTitle: "Encoded Motors"
 weight: 90
 type: "docs"

diff --git a/docs/components/motor/gpiostepper.md b/docs/components/motor/gpiostepper.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a gpiostepper motor"
+title: "Configure a GPIO-Controlled Stepper Motor"
 linkTitle: "gpiostepper"
 weight: 20
 type: "docs"

diff --git a/docs/components/motor/roboclaw.md b/docs/components/motor/roboclaw.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a roboclaw motor"
+title: "Configure a RoboClaw-Controlled Motor"
 linkTitle: "roboclaw"
 weight: 22
 type: "docs"

diff --git a/docs/components/motor/tmc5072.md b/docs/components/motor/tmc5072.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a TMC5072 motor"
+title: "Configure a TMC5072-Controlled Stepper Motor"
 linkTitle: "TMC5072"
 weight: 50
 type: "docs"

diff --git a/docs/components/movement-sensor/cameramono.md b/docs/components/movement-sensor/cameramono.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a camera_mono model for Visual Odometry"
+title: "Configure a camera_mono Model for Visual Odometry"
 linkTitle: "camera_mono"
 weight: 40
 type: "docs"

diff --git a/docs/components/movement-sensor/gps/gps-nmea-rtk-pmtk.md b/docs/components/movement-sensor/gps/gps-nmea-rtk-pmtk.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an NTRIP-based RTK GPS with an I2C Connection"
+title: "Configure an NTRIP-Based RTK GPS with an I2C Connection"
 linkTitle: "gps-nmea-rtk-pmtk"
 weight: 10
 type: "docs"

diff --git a/docs/components/movement-sensor/gps/gps-nmea-rtk-serial.md b/docs/components/movement-sensor/gps/gps-nmea-rtk-serial.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an NTRIP-based RTK GPS with a Serial Connection"
+title: "Configure an NTRIP-Based RTK GPS with a Serial Connection"
 linkTitle: "gps-nmea-rtk-serial"
 weight: 10
 type: "docs"

diff --git a/docs/components/movement-sensor/gps/gps-nmea.md b/docs/components/movement-sensor/gps/gps-nmea.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an NMEA-based GPS"
+title: "Configure an NMEA-Based GPS"
 linkTitle: "gps-nmea"
 weight: 10
 type: "docs"

diff --git a/docs/components/movement-sensor/merged.md b/docs/components/movement-sensor/merged.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a merged movement sensor"
+title: "Configure a Merged Movement Sensor"
 linkTitle: "merged"
 weight: 40
 type: "docs"

diff --git a/docs/components/movement-sensor/wheeled-odometry.md b/docs/components/movement-sensor/wheeled-odometry.md
@@ -1,8 +1,8 @@
 ---
-title: "Configure a wheeled-odometry movement sensor"
+title: "Configure a Wheeled Odometry Movement Sensor"
 linkTitle: "wheeled-odometry"
 type: "docs"
-description: "Configure a wheeled-odometry movement sensor."
+description: "Configure a wheeled odometry movement sensor."
 images: ["/icons/components/imu.svg"]
 tags:
   [

diff --git a/docs/components/power-sensor/fake.md b/docs/components/power-sensor/fake.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure a fake power sensor"
+title: "Configure a Fake Power Sensor"
 linkTitle: "fake"
 weight: 10
 type: "docs"

diff --git a/docs/components/power-sensor/ina219.md b/docs/components/power-sensor/ina219.md
@@ -1,5 +1,5 @@
 ---
-title: "Configure an INA219 power sensor"
+title: "Configure an INA219 Power Sensor"
 linkTitle: "ina219"
 weight: 10
 draft: false