Skip to content

Commit

Permalink
Fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
@npentrel
npentrel committed Jan 13, 2025
1 parent caaae46 commit e7d3633
Show file tree
Hide file tree
Showing 21 changed files with 101 additions and 105 deletions.
2 changes: 1 addition & 1 deletion static/include/app/apis/generated/app.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2210,7 +2210,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/

### RotateKey

Rotate an [API key](/cloud/rbac/#api-keys).
Rotate an [API key](/manage/manage/access/#rotate-an-api-key).

{{< tabs >}}
{{% tab name="Python" %}}
Expand Down
3 changes: 1 addition & 2 deletions static/include/app/apis/generated/data_sync.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ Uploaded tabular data can be found under the **Sensors** subtab of the app's [**

**Parameters:**

- `tabular_data` (List[Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]]) (required): List of the data to be uploaded, represented tabularly as a collection of dictionaries.
Must include the key `"readings"` for sensors.
- `tabular_data` (List[Mapping[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]]) (required): List of the data to be uploaded, represented tabularly as a collection of dictionaries. Must include the key “readings” for sensors.
- `part_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): Part ID of the component used to capture the data.
- `component_type` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): Type of the component used to capture the data (for example, “rdk:component:movement_sensor”).
- `component_name` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): Name of the component used to capture the data.
Expand Down
2 changes: 1 addition & 1 deletion static/include/app/apis/overrides/protos/app.GetRobotApiKeys.md
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Gets the [API keys](/manage/manage/access/) for the machine.
Gets the [API keys](/cloud/rbac/#api-keys) for the machine.
14 changes: 7 additions & 7 deletions static/include/components/apis/generated/arm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Pose](https://flutter.viam.dev/viam_sdk/Pose-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Pose](https://flutter.viam.dev/viam_sdk/Pose-class.html)\>

**Example:**

Expand Down Expand Up @@ -142,7 +142,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -237,7 +237,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -353,7 +353,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\>

**Example:**

Expand Down Expand Up @@ -472,7 +472,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>

**Example:**

Expand Down Expand Up @@ -545,7 +545,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -709,7 +709,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>

**Example:**

Expand Down
14 changes: 7 additions & 7 deletions static/include/components/apis/generated/base.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -147,7 +147,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -261,7 +261,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -351,7 +351,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -503,7 +503,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>

**Example:**

Expand Down Expand Up @@ -580,7 +580,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -745,7 +745,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>

**Example:**

Expand Down
22 changes: 11 additions & 11 deletions static/include/components/apis/generated/board.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -150,7 +150,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>

**Example:**

Expand Down Expand Up @@ -240,7 +240,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>

**Example:**

Expand Down Expand Up @@ -325,7 +325,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -407,7 +407,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\>

**Example:**

Expand Down Expand Up @@ -496,7 +496,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -580,7 +580,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[int](https://api.flutter.dev/flutter/dart-core/int-class.html)\>

**Example:**

Expand Down Expand Up @@ -666,7 +666,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[AnalogValue](https://flutter.viam.dev/viam_sdk/AnalogValue.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[AnalogValue](https://flutter.viam.dev/viam_sdk/AnalogValue.html)\>

**Example:**

Expand Down Expand Up @@ -750,7 +750,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -929,7 +929,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -1223,7 +1223,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>

**Example:**

Expand Down
8 changes: 4 additions & 4 deletions static/include/components/apis/generated/camera.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\>

**Example:**

Expand Down Expand Up @@ -252,7 +252,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[ViamImage](https://flutter.viam.dev/viam_sdk/ViamImage-class.html)\>

**Example:**

Expand Down Expand Up @@ -313,7 +313,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[CameraProperties](https://flutter.viam.dev/viam_sdk/CameraProperties.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[CameraProperties](https://flutter.viam.dev/viam_sdk/CameraProperties.html)\>

**Example:**

Expand Down Expand Up @@ -367,7 +367,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>

**Example:**

Expand Down
14 changes: 7 additions & 7 deletions static/include/components/apis/generated/gantry.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\>

**Example:**

Expand Down Expand Up @@ -149,7 +149,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -222,7 +222,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[List](https://api.flutter.dev/flutter/dart-core/List-class.html)\<[double](https://api.flutter.dev/flutter/dart-core/double-class.html)\>\>

**Example:**

Expand Down Expand Up @@ -293,7 +293,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>

**Example:**

Expand Down Expand Up @@ -373,7 +373,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>

**Example:**

Expand Down Expand Up @@ -447,7 +447,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -498,7 +498,7 @@ If you are implementing your own gantry and add features that have no built-in A

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>

**Example:**

Expand Down
2 changes: 1 addition & 1 deletion static/include/components/apis/generated/generic_component.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>

**Example:**

Expand Down
10 changes: 5 additions & 5 deletions static/include/components/apis/generated/gripper.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -130,7 +130,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/c

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -207,7 +207,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[bool](https://api.flutter.dev/flutter/dart-core/bool-class.html)\>

**Example:**

Expand Down Expand Up @@ -281,7 +281,7 @@ For more information, see the [Go SDK Docs](https://pkg.go.dev/go.viam.com/rdk/r

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<void\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<void\>

**Example:**

Expand Down Expand Up @@ -395,7 +395,7 @@ If you are implementing your own gripper and add features that have no built-in

**Returns:**

- [Future](https://api.flutter.dev/flutter/dart-core/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>
- [Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)\<[Map](https://api.flutter.dev/flutter/dart-core/Map-class.html)\<[String](https://api.flutter.dev/flutter/dart-core/String-class.html), dynamic\>\>

**Example:**

Expand Down
Loading

0 comments on commit e7d3633

Please sign in to comment.