Skip to content

Commit

Permalink
DOCS-3416: Add aliases for more broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT committed Jan 21, 2025
1 parent c443582 commit f3a571b
Show file tree
Hide file tree
Showing 15 changed files with 42 additions and 7 deletions.
3 changes: 3 additions & 0 deletions docs/data-ai/ai/train-tflite.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ aliases:
- /data-management/data-management-tutorial/
- /tutorials/services/data-management-tutorial/
- /tutorials/services/data-mlmodel-tutorial/
- /extend/modular-resources/examples/tflite-module/
- /modular-resources/examples/tflite-module/
- /registry/examples/tflite-module/
languages: []
viamresources: ["data_manager", "mlmodel", "vision"]
platformarea: ["ml"]
Expand Down
8 changes: 5 additions & 3 deletions docs/operate/control/headless-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ type: "docs"
description: "Run control logic on a machine."
images: ["/general/code.png"]
aliases:
- "product-overviews/sdk-as-client"
- "program/sdk-as-client"
- "program/sdks"
- /product-overviews/sdk-as-client/
- /program/sdk-as-client/
- /program/sdks/
- /program/
- /program/run/
- /program/debug/
- /how-tos/develop-app/
- /use-cases/develop-app/
- /product-overviews/sdk-as-client/
---

To write control logic for your machine that will run without a user interface, you can use the Python, Go, or C++ SDK.
Expand Down
10 changes: 10 additions & 0 deletions docs/operate/get-started/other-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ aliases:
- /modular-resources/key-concepts/
- /modular-resources/
- /how-tos/upload-module/
- /extend/modular-resources/examples/custom-arm/
- /modular-resources/examples/custom-arm/
- /registry/examples/custom-arm/
- /program/extend/modular-resources/examples/
- /extend/modular-resources/examples/
- /modular-resources/examples/
- /registry/examples/
- /extend/modular-resources/upload/
- /modular-resources/upload/
- /registry/upload/
prev: "/operate/get-started/supported-hardware/"
next: "/operate/get-started/other-hardware/hello-world-module/"
---
Expand Down
6 changes: 4 additions & 2 deletions docs/operate/get-started/supported-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type: "docs"
description: "Use supported hardware with your machine."
modulescript: true
aliases:
- program/extend/modular-resources/configure/
- /program/extend/modular-resources/configure/
- /extend/modular-resources/configure/
- /modular-resources/configure/
- /registry/configure/
Expand All @@ -16,7 +16,9 @@ aliases:
- /manage/configuration/
- /build/configure/
- /registry/
- "program/extend/modular-resources/configure/"
- /registry/program/extend/modular-resources/configure/
- /how-tos/use-cases/configure/
- /use-cases/configure/
prev: "/operate/get-started/setup/"
next: "/operate/get-started/other-hardware/"
---
Expand Down
2 changes: 2 additions & 0 deletions docs/operate/mobility/move-arm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ type: "docs"
description: "Move an arm with joint positions or automated motion planning."
aliases:
- /how-tos/move-robot-arm/
- /tutorials/motion/accessing-and-moving-robot-arm/
- /tutorials/motion/
---

You have two options for moving a robotic [arm](/operate/reference/components/arm/):
Expand Down
1 change: 1 addition & 0 deletions docs/operate/mobility/move-base.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ type: "docs"
description: "Move a mobile robot with manual or autonomous navigation."
aliases:
- /how-tos/navigate/
- /use-cases/navigate/
---

You have three options for moving a mobile robot [base](/operate/reference/components/base/):
Expand Down
1 change: 1 addition & 0 deletions docs/operate/reference/components/arm/lite6.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ description: "Configure a UFACTORY Lite 6 arm for your machine."
tags: ["arm", "components"]
aliases:
- "/components/arm/xarmlite/"
- /components/arm/lite6/
component_description: "Supports UFACTORY Lite 6."
# SMEs: Bucket, Motion
---
Expand Down
2 changes: 2 additions & 0 deletions docs/operate/reference/components/board/pi5.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ images: ["/icons/components/board.svg"]
tags: ["board", "components"]
component_description: "Supports Raspberry Pi 5."
usage: 999999
aliases:
- /components/board/pi5/
# SMEs: Bucket, Alan
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: "Follow this guide to set up your own SparkFun RTK base station, a
images: ["/icons/components/imu.svg"]
no_component: true
date: "2024-01-01"
aliases:
- /components/movement-sensor/set-up-base-station/
# updated: "" # When the content was last entirely checked
# SMEs: Susmita
---
Expand Down
1 change: 1 addition & 0 deletions docs/operate/reference/prepare/odroid-c4-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ no_list: true
aliases:
- /get-started/installation/prepare/odroid-c4-setup/
- /get-started/prepare/odroid-c4-setup/
- /installation/prepare/odroid-c4-setup/
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
# SME: Olivia Miller
Expand Down
1 change: 1 addition & 0 deletions docs/operate/reference/prepare/orange-pi-3-lts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ no_list: true
aliases:
- /get-started/installation/prepare/orange-pi-3-lts/
- /get-started/prepare/orange-pi-3-lts/
- /installation/prepare/orange-pi-3-lts/
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
# SME: Olivia Miller
Expand Down
1 change: 1 addition & 0 deletions docs/operate/reference/prepare/orange-pi-zero2.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ no_list: true
aliases:
- /get-started/installation/prepare/orange-pi-zero2/
- /get-started/prepare/orange-pi-zero2/
- /installation/prepare/orange-pi-zero2/
date: "2022-01-01"
# updated: "" # When the content was last entirely checked
# SME: Olivia Miller
Expand Down
1 change: 1 addition & 0 deletions docs/operate/reference/services/generic/fake.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ service_description: "A model used for testing a generic service."
tags: ["generic", "services"]
aliases:
- /registry/advanced/generic/fake/
- /services/generic/fake/
---

Configure a `fake` generic service to test implementing a generic service on your machine:
Expand Down
9 changes: 7 additions & 2 deletions docs/operate/reference/services/slam/cloudslam/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,18 @@ tags: ["slam", "services"]
icon: true
images: ["/services/icons/slam.svg"]
date: "2022-01-01"
aliases:
- /services/slam/cloudslam/
# updated: "" # When the content was last entirely checked
# SMEs: John N.
---

SLAM Algorithms can have varying levels of resource requirements in order to run effectively. `Cartographer` in particular can require a significant amount of CPU resources to build and manage large maps. In order to better support running SLAM on resource limited machines, Viam provides a service to run SLAM algorithms for machines in the cloud as well as management of the maps generated in their location.
SLAM Algorithms can have varying levels of resource requirements in order to run effectively.
`Cartographer` in particular can require a significant amount of CPU resources to build and manage large maps.
In order to better support running SLAM on resource limited machines, Viam provides a service to run SLAM algorithms for machines in the cloud as well as management of the maps generated in their location.

CloudSLAM can be used with both a live machine or with previously captured data in your location. In [live mode](#mapping-with-a-live-machine-online-mode) using the [data management service](/data-ai/capture-data/capture-sync/) and the [cloudslam-wrapper](https://github.com/viam-modules/cloudslam-wrapper) module, Viam takes your LiDAR camera and movement sensor data from your local machine and sends it to the cloudslam server.
CloudSLAM can be used with both a live machine or with previously captured data in your location.
In [live mode](#mapping-with-a-live-machine-online-mode) using the [data management service](/data-ai/capture-data/capture-sync/) and the [cloudslam-wrapper](https://github.com/viam-modules/cloudslam-wrapper) module, Viam takes your LiDAR camera and movement sensor data from your local machine and sends it to the cloudslam server.
The CloudSLAM server will then process that data and produce a map that can then be used on any machine in your location.
When using an [offline machine](#using-previously-captured-data-offline-mode), you can select data from specific sensors over a period of time to build a map with.

Expand Down
1 change: 1 addition & 0 deletions docs/tutorials/control/drive-rover.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ aliases:
- "/get-started/try-viam/try-viam-tutorial/"
- "/get-started/quickstarts/drive-rover/"
- "/how-tos/drive-rover/"
- /get-started/drive-rover/
tags: ["base", "viam rover", "try viam", "sdk", "python", "flutter"]
level: "Beginner"
authors: []
Expand Down

0 comments on commit f3a571b

Please sign in to comment.