Skip to content

Commit f502e01

Browse files
Fix prettier and revert service links not yet on main
Keep base-rc, discovery, generic, navigation, and slam service links pointing to /operate/reference/services/ since those pages haven't been migrated to /reference/services/ on main yet. Also fix prettier formatting on monitor/overview.md. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c319423 commit f502e01

9 files changed

Lines changed: 18 additions & 18 deletions

File tree

docs/build-modules/write-a-cpp-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For example, the [sensor API](/reference/apis/components/sensor/) has a `GetRead
6161
If instead of just getting readings, you actually have an encoder and need to be able to reset the zero position, use the [encoder API](/reference/apis/components/encoder/) so you can define functionality behind the `GetPosition` and `ResetPosition` methods.
6262

6363
In addition to the list of methods, another reason to choose one API over another is how certain APIs fit into the Viam ecosystem.
64-
For example, though you could technically implement a GPS as a sensor with just the `GetReadings` method, if you implement it as a movement sensor then you have access to methods like `GetCompassHeading` which allow you to use your GPS module with the [navigation service](/reference/services/navigation/).
64+
For example, though you could technically implement a GPS as a sensor with just the `GetReadings` method, if you implement it as a movement sensor then you have access to methods like `GetCompassHeading` which allow you to use your GPS module with the [navigation service](/operate/reference/services/navigation/).
6565
For this reason, it's generally best to choose the API that most closely matches your hardware or software.
6666
{{< /expand >}}
6767

docs/monitor/overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ See [Troubleshoot problems](/monitor/troubleshoot/).
6565

6666
This section covers tools for monitoring, operating, and debugging machines that are already configured and running.
6767

68-
| If you need to... | See |
69-
| ---------------------------------------------- | --------------------------------------- |
70-
| Set up a machine for the first time | [Get started](/set-up-a-machine/) |
71-
| Configure components and services | [Configure hardware](/hardware/) |
72-
| Capture and sync data from sensors | [Manage data](/data/) |
73-
| Train and deploy ML models | [Train ML models](/train/) |
68+
| If you need to... | See |
69+
| ---------------------------------------------- | ----------------------------------- |
70+
| Set up a machine for the first time | [Get started](/set-up-a-machine/) |
71+
| Configure components and services | [Configure hardware](/hardware/) |
72+
| Capture and sync data from sensors | [Manage data](/data/) |
73+
| Train and deploy ML models | [Train ML models](/train/) |
7474
| Build a custom web or mobile app with the SDKs | [Build apps](/build-apps/overview/) |
75-
| Manage fleet deployment and provisioning | [Fleet deployment](/fleet/) |
75+
| Manage fleet deployment and provisioning | [Fleet deployment](/fleet/) |

docs/reference/apis/services/base-rc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ aliases:
1616

1717
The base remote control service API allows you to get a list of inputs from the controller that are being monitored for that control mode.
1818

19-
The [Base remote control service](/reference/services/base-rc/) supports the following methods:
19+
The [Base remote control service](/operate/reference/services/base-rc/) supports the following methods:
2020

2121
{{< readfile "/static/include/services/apis/generated/base_remote_control-table.md" >}}
2222

docs/reference/apis/services/discovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ aliases:
1212
---
1313

1414
The discovery service API allows you to get a list of resources available to configure on a machine based on the hardware that is connected to or part of the machine.
15-
Discoverable resources can include components that are physically connected to the machine, as well as components that are available on the machine's local network (depending on the implementation of the [discovery service](/reference/services/discovery/)).
15+
Discoverable resources can include components that are physically connected to the machine, as well as components that are available on the machine's local network (depending on the implementation of the [discovery service](/operate/reference/services/discovery/)).
1616

1717
The discovery service supports the following methods:
1818

docs/reference/apis/services/generic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ aliases:
1414
# updated: "" # When the content was last entirely checked
1515
---
1616

17-
The generic service API allows you to give commands to your [generic services](/reference/services/generic/) for running model-specific commands using [`DoCommand`](/reference/apis/services/generic/#docommand).
17+
The generic service API allows you to give commands to your [generic services](/operate/reference/services/generic/) for running model-specific commands using [`DoCommand`](/reference/apis/services/generic/#docommand).
1818

1919
The generic service supports the following methods:
2020

docs/reference/apis/services/navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ aliases:
1616

1717
The navigation service API allows you to define waypoints and move your machine along those waypoints while avoiding obstacles.
1818

19-
The [navigation service](/reference/services/navigation/) supports the following methods:
19+
The [navigation service](/operate/reference/services/navigation/) supports the following methods:
2020

2121
{{< readfile "/static/include/services/apis/generated/navigation-table.md" >}}
2222

docs/reference/glossary/slam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ aliases:
99

1010
SLAM (Simultaneous Localization and Mapping) algorithms use data from a machine's sensors, like LiDARs, cameras, and movement sensors, to generate a map of the environment and determine the machine's position within it.
1111

12-
For more information, see [SLAM](/reference/services/slam/).
12+
For more information, see [SLAM](/operate/reference/services/slam/).

docs/tutorials/control/gamepad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ To link the controller input to the base functionality, you need to add the base
123123
## Add the base remote control service
124124

125125
Services are software packages that provide robots with higher level functionality.
126-
To link the controller's input to the base functionality, you need to configure the [base remote control service](/reference/services/base-rc/):
126+
To link the controller's input to the base functionality, you need to configure the [base remote control service](/operate/reference/services/base-rc/):
127127

128128
{{< tabs >}}
129129
{{% tab name="Config Builder" %}}

docs/tutorials/services/navigate-with-rover-base.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ weight: 5
3737
# SMEs: Ray Bjorkman, Fahmina
3838
---
3939

40-
The [navigation service](/reference/services/navigation/) allows you to queue up user-defined waypoints for your machine to move to in the order that you specify.
40+
The [navigation service](/operate/reference/services/navigation/) allows you to queue up user-defined waypoints for your machine to move to in the order that you specify.
4141
You can also add obstacles or set linear and angular velocity targets in your navigation service config.
4242
Viam's motion planner will plan routes that avoid those obstacles and attempt to keep the robot at your specified velocity.
4343

@@ -72,7 +72,7 @@ Follow this tutorial to get started using Viam's Navigation service to help your
7272
3. A [`merged`](/reference/components/movement-sensor/merged/) model aggregating the readings together for the navigation service to consume.
7373

7474
You can use any combo of movement sensors you want as long as you are getting all the types of measurements required.
75-
See [the navigation service](/reference/services/navigation/#requirements) for more info on movement sensor requirements.
75+
See [the navigation service](/operate/reference/services/navigation/#requirements) for more info on movement sensor requirements.
7676

7777
{{% alert title="Tip" color="tip" %}}
7878

@@ -456,15 +456,15 @@ To add the navigation service to your robot, do the following:
456456
```
457457

458458
Edit the attributes as applicable.
459-
Attribute information is available in [the navigation service documentation](/reference/services/navigation/#configuration).
459+
Attribute information is available in [the navigation service documentation](/operate/reference/services/navigation/#configuration).
460460

461461
1. Click **Save** in the top right corner of the screen to save your changes.
462462

463463
Your navigation service should now appear in your machine's **CONFIGURE** tab as a card with a map like the following:
464464

465465
{{<imgproc src="/tutorials/navigate-with-rover-base/navigation-config-builder.png" resize="1200x" declaredimensions=true alt="Navigation Card" style="width:650px" class="shadow imgzoom" >}}
466466

467-
For more detailed information see [the navigation service](/reference/services/navigation/#configuration).
467+
For more detailed information see [the navigation service](/operate/reference/services/navigation/#configuration).
468468

469469
{{% /tab %}}
470470
{{% tab name="JSON" %}}

0 commit comments

Comments
 (0)