From f3e9d7288850fb627bfc8e57bd5bf9a156fbf153 Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Thu, 14 Sep 2023 16:13:48 -0400 Subject: [PATCH] Make component config sections correct and consistent (#1799) Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> --- docs/components/arm/_index.md | 2 +- docs/components/base/_index.md | 2 +- docs/components/camera/_index.md | 2 +- docs/components/encoder/_index.md | 6 +----- docs/components/gantry/_index.md | 2 +- docs/components/gantry/single-axis.md | 3 ++- docs/components/sensor/_index.md | 2 +- docs/components/servo/_index.md | 2 +- 8 files changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/components/arm/_index.md b/docs/components/arm/_index.md index 21d3d7659c..a4e3661fe9 100644 --- a/docs/components/arm/_index.md +++ b/docs/components/arm/_index.md @@ -49,7 +49,7 @@ Arm drivers are also paired, in the RDK, with JSON files that describe the kinem ## Configuration -Supported arm models include: +For configuration information, click on one of the supported arm models: | Model | Description | | ----- | ----------- | diff --git a/docs/components/base/_index.md b/docs/components/base/_index.md index 53f2de9d9c..e1e6cd69bd 100644 --- a/docs/components/base/_index.md +++ b/docs/components/base/_index.md @@ -28,7 +28,7 @@ Most mobile robots with a base need at least the following hardware: ## Configuration -Supported base models include: +For configuration information, click on one of the supported base models: | Model | Description | | ----- | ----------- | diff --git a/docs/components/camera/_index.md b/docs/components/camera/_index.md index add028230e..049de515a1 100644 --- a/docs/components/camera/_index.md +++ b/docs/components/camera/_index.md @@ -33,7 +33,7 @@ You can use different models to: ## Configuration -For configuration information, click on one of the following models: +For configuration information, click on one of the supported camera models: | Model | Description | | ----- | ----------- | diff --git a/docs/components/encoder/_index.md b/docs/components/encoder/_index.md index d32762e93e..4068ee0bda 100644 --- a/docs/components/encoder/_index.md +++ b/docs/components/encoder/_index.md @@ -33,11 +33,7 @@ Most robots with an encoder need at least the following hardware: ## Configuration -To configure an encoder as a component of your robot, first configure the [board](/components/board/) controlling the encoder. -If you are configuring an encoded motor, you must also configure the [motor](/components/motor/) first. - -The configuration of your encoder component depends on your encoder model. -For configuration information, click on one of the following models: +For configuration information, click on one of the supported encoder models: | Model | Description | | ----- | ----------- | diff --git a/docs/components/gantry/_index.md b/docs/components/gantry/_index.md index 7ac1fcd3c7..3a11356b7c 100644 --- a/docs/components/gantry/_index.md +++ b/docs/components/gantry/_index.md @@ -36,7 +36,7 @@ Most robots with a gantry need at least the following hardware: ## Configuration -Supported gantry models include: +For configuration information, click on one of the supported gantry models: | Model | Description | | ----- | ----------- | diff --git a/docs/components/gantry/single-axis.md b/docs/components/gantry/single-axis.md index 2dcfcc51d0..5956590d5b 100644 --- a/docs/components/gantry/single-axis.md +++ b/docs/components/gantry/single-axis.md @@ -11,7 +11,8 @@ aliases: # SME: Rand, Martha --- -Configure a `single-axis` gantry to integrate a single-axis gantry into your robot: +Configure a `single-axis` gantry to integrate a single-axis gantry into your robot. +Before configuring the gantry, configure any [motor components](/components/motor/) that are part of the gantry. {{< tabs >}} {{% tab name="Config Builder" %}} diff --git a/docs/components/sensor/_index.md b/docs/components/sensor/_index.md index 93960c3a45..851723b294 100644 --- a/docs/components/sensor/_index.md +++ b/docs/components/sensor/_index.md @@ -31,7 +31,7 @@ Most robots with a sensor need at least the following hardware: ## Configuration -Supported sensor models include: +For configuration information, click on one of the supported sensor models: | Model | Description | | ----- | ----------- | diff --git a/docs/components/servo/_index.md b/docs/components/servo/_index.md index 544eadf957..9af2be3125 100644 --- a/docs/components/servo/_index.md +++ b/docs/components/servo/_index.md @@ -40,7 +40,7 @@ Check your device's data sheet and configure that type of servo as an [encoded m {{% /alert %}} -Supported servo models include: +For configuration information, click on one of the supported servo models: | Model | Description | | ----- | ----------- |