DOCS-4059: Update terminology from Viam app to Viam #4379

promptless · 2025-06-04T08:02:08Z

Based on the user request to change all references from "the Viam app" to just "Viam" (e.g., "in the viam app" becomes "in Viam"), this suggestion systematically updates the terminology throughout the documentation to use the simplified form. This change affects hundreds of references across the documentation and makes the language more concise and consistent with current branding preferences.

Trigger Events

Internal discussion about changing terminology from "the Viam app" to just "Viam" throughout documentation or content.

If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)

viambot · 2025-06-04T08:02:20Z

👋 Thanks for contributing! A reviewer will look at it on the next working day!

promptless · 2025-06-04T08:02:24Z

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

netlify · 2025-06-04T08:02:50Z

✅ Deploy Preview for viam-docs ready!

Name	Link
🔨 Latest commit	`89434f6`
🔍 Latest deploy log	https://app.netlify.com/projects/viam-docs/deploys/6841d06274e28c000841f621
😎 Deploy Preview	https://deploy-preview-4379--viam-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 24 (🔴 down 24 from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: 70 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

npentrel · 2025-06-04T08:08:53Z

@Promptless please change all remaining occurrences of "the Viam app" to just "Viam"

nathan-contino

Can we take this opportunity to reword all "In the Viam app, open the example-tab tab of the example-page page" verbiage to "In Viam > example-page > example-tab? I think it would make a lot of app usage clearer, less wordy, and easier to follow, and it would guarantee a link every time we instruct users to visit the app.

Other than that, LGTM!

Edit: in case it isn't clear, my suggestions below are examples of this pattern, by no means comprehensive. But Jessamy and myself have talked about this pattern before, when I asked about "page" vs "tab" soon after joining.

nathan-contino · 2025-06-05T18:21:46Z

docs/data-ai/data/export.md

@@ -43,7 +43,7 @@ To export your data from the cloud using the Viam CLI:
 {{% tablestep number=1 %}}
 **Filter the data you want to download**

-Navigate to the [**DATA** page in the Viam app](https://app.viam.com/data/view).
+Navigate to the [**DATA**](https://app.viam.com/data/view).


For example:

Suggested change

Navigate to the [**DATA**](https://app.viam.com/data/view).

Navigate to [Viam > DATA](https://app.viam.com/data/view).

Or just this:

Suggested change

Navigate to the [**DATA**](https://app.viam.com/data/view).

Navigate to the [**DATA**](https://app.viam.com/data/view) page.

nathan-contino · 2025-06-05T18:22:28Z

docs/data-ai/data/visualize.md

 ---

-Once you have used the data management service to [capture data](/data-ai/capture-data/capture-sync/), you can visualize your data on a dashboard with the Viam app's **TELEOP** page or a variety of third-party tools, including Grafana, Tableau, Google's Looker Studio, and more.
+Once you have used the data management service to [capture data](/data-ai/capture-data/capture-sync/), you can visualize your data on a dashboard with the **TELEOP** page or a variety of third-party tools, including Grafana, Tableau, Google's Looker Studio, and more.


Suggested change

Once you have used the data management service to [capture data](/data-ai/capture-data/capture-sync/), you can visualize your data on a dashboard with the **TELEOP** page or a variety of third-party tools, including Grafana, Tableau, Google's Looker Studio, and more.

Once you have used the data management service to [capture data](/data-ai/capture-data/capture-sync/), you can visualize your data on a dashboard in [Viam > TELEOP](https://app.viam.com/teleop) or a variety of third-party tools, including Grafana, Tableau, Google's Looker Studio, and more.

nathan-contino · 2025-06-05T18:23:16Z

docs/dev/reference/apis/components/camera.md

@@ -26,8 +26,7 @@ The camera component supports the following methods:

 ## Establish a connection

-To get started using Viam's SDKs to connect to and control your camera and the rest of your machine, go to your machine's page on the [Viam app](https://app.viam.com),
-Navigate to the **CONNECT** tab's **Code sample** page, select your preferred programming language, and copy the sample code.
+To get started using Viam's SDKs to connect to and control your camera and the rest of your machine, go to your machine's page, navigate to the **CONNECT** tab's **Code sample** page, select your preferred programming language, and copy the sample code.


Suggested change

To get started using Viam's SDKs to connect to and control your camera and the rest of your machine, go to your machine's page, navigate to the **CONNECT** tab's **Code sample** page, select your preferred programming language, and copy the sample code.

To get started using Viam's SDKs to connect to and control your camera and the rest of your machine, go to your machine's page, navigate to [Viam > CONNECT > Code sample](https://app.viam.com/connect/code-sample), select your preferred programming language, and copy the sample code.

JessamyT · 2025-06-05T21:42:44Z

docs/data-ai/ai/create-dataset.md


 {{< tabs >}}
-{{% tab name="Viam app" %}}
+{{% tab name="web UI" %}}


Suggested change

{{% tab name="web UI" %}}

{{% tab name="Web UI" %}}

[nit]

JessamyT · 2025-06-05T21:43:24Z

docs/data-ai/ai/create-dataset.md

@@ -194,9 +194,9 @@ Repeat these steps for all images in the dataset.
 ## Add tagged images to a dataset

 {{< tabs >}}
-{{% tab name="Viam app" %}}
+{{% tab name="web UI" %}}


Suggested change

{{% tab name="web UI" %}}

{{% tab name="Web UI" %}}

[nit]

JessamyT · 2025-06-05T21:43:33Z

docs/data-ai/ai/deploy.md

@@ -32,7 +32,7 @@ After training or uploading a machine learning model, use a machine learning (ML

 ## Deploy your ML model on an ML model service

-1. Navigate to the **CONFIGURE** tab of one of your machine in the [Viam app](https://app.viam.com).
+1. Navigate to the **CONFIGURE** tab of one of your machine.


Suggested change

1. Navigate to the **CONFIGURE** tab of one of your machine.

1. Navigate to the **CONFIGURE** tab of one of your machines.

JessamyT · 2025-06-05T21:44:45Z

docs/data-ai/ai/train.md

@@ -772,16 +772,15 @@ You can view uploaded training scripts by navigating to the [registry's **Traini

 ## Submit a training job

-After uploading the training script, you can run it by submitting a training job through the Viam app or using the Viam CLI or [ML Training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).
+After uploading the training script, you can run it by submitting a training job using the web UI, the CLI or the [ML Training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).


Suggested change

After uploading the training script, you can run it by submitting a training job using the web UI, the CLI or the [ML Training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).

After uploading the training script, you can run it by submitting a training job using the web UI, the CLI or the [ML training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).

[ood nit]

JessamyT · 2025-06-05T21:44:58Z

docs/data-ai/ai/train.md

-{{% tab name="Viam app" min-height="150px" %}}
-
-In the Viam app, navigate to your list of [**DATASETS**](https://app.viam.com/data/datasets) and select the one you want to train a model on.
+{{% tab name="web UI" min-height="150px" %}}


Suggested change

{{% tab name="web UI" min-height="150px" %}}

{{% tab name="Web UI" min-height="150px" %}}

[nit]

JessamyT · 2025-06-05T21:45:39Z

docs/data-ai/capture-data/filter-before-sync.md


 {{% /tablestep %}}
 {{% tablestep number=7 %}}
-**View filtered data in the Viam app**
+**View filtered data on Viam**


Suggested change

**View filtered data on Viam**

**View filtered data in the Viam web UI**

JessamyT · 2025-06-05T22:00:08Z

docs/manage/fleet/system-settings.md

@@ -49,7 +49,7 @@ This is primarily useful for a machine that moves between different networks, so
 To add networks, add or update the `additional_networks` field to the `agent` object and set `"turn_on_hotspot_if_wifi_has_no_internet": true`.

 {{< alert title="Note" color="note" >}}
-If you are using the Viam app to add networks to a machine’s configuration, the machine will need to be connected to the internet to retrieve the configuration information containing the network credentials before it can use them.
+If you are adding networks to a machine’s configuration, the machine will need to be connected to the internet to retrieve the configuration information containing the network credentials before it can use them.


Suggested change

If you are adding networks to a machine’s configuration, the machine will need to be connected to the internet to retrieve the configuration information containing the network credentials before it can use them.

If you are using the web UI to add networks to a machine’s configuration, the machine will need to be connected to the internet to retrieve the configuration information containing the network credentials before it can use them.

In case there's a local way to do this?

JessamyT · 2025-06-05T22:03:12Z

docs/manage/troubleshoot/teleoperate/default-interface.md

@@ -37,7 +37,7 @@ You can also switch between different machine parts directly from the **CONTROL*

 {{<gif webm_src="/fleet/mobile-app-control.webm" mp4_src="/fleet/mobile-app-control.mp4" alt="Using the control interface under the locations tab on the Viam mobile app" class="alignright" max-width="300px">}}

-In addition to the Viam app, the [Viam mobile app](/manage/troubleshoot/teleoperate/default-interface/#viam-mobile-app) also allows you to test, monitor and remotely operate machines in your fleet.
+The [Viam mobile app](/manage/troubleshoot/teleoperate/default-interface/#viam-mobile-app) also allows you to test, monitor and remotely operate machines in your fleet.


Suggested change

The [Viam mobile app](/manage/troubleshoot/teleoperate/default-interface/#viam-mobile-app) also allows you to test, monitor and remotely operate machines in your fleet.

Like the web UI, the [Viam mobile app](/manage/troubleshoot/teleoperate/default-interface/#viam-mobile-app) also allows you to test, monitor and remotely operate machines in your fleet.

To avoid confusion of thinking that you can only do these things in the mobile app.

JessamyT · 2025-06-05T22:05:03Z

docs/operate/get-started/basics.md

 - Simple APIs for common types of hardware (for example, cameras, sensors, and motors), and software services (such as computer vision).
 - A registry of modules that implement the hardware and software APIs.
  This includes support for many popular hardware models.
 - SDKs for many programming languages that you can use to interact with your machines.

-`viam-server` connects your machine to the Viam app and to SDK clients.
+`viam-server` connects your machine to Viam and to SDK clients.


Suggested change

`viam-server` connects your machine to Viam and to SDK clients.

`viam-server` connects your machine to the Viam cloud and to SDK clients.

Since we just used "Viam" more broadly above

JessamyT · 2025-06-05T22:07:02Z

docs/operate/get-started/other-hardware/cpp-module.md

+If desired, you can configure your module to output log messages to Viam.
+Log messages sent to Viam appear on the [**LOGS** tab](/manage/troubleshoot/troubleshoot/#check-logs) for your machine in an easily-parsable and searchable manner.


Suggested change

If desired, you can configure your module to output log messages to Viam.

Log messages sent to Viam appear on the [**LOGS** tab](/manage/troubleshoot/troubleshoot/#check-logs) for your machine in an easily-parsable and searchable manner.

If desired, you can configure your module to output log messages.

Log messages appear on the [**LOGS** tab](/manage/troubleshoot/troubleshoot/#check-logs) for your machine in an easily-parsable and searchable manner.

Otherwise sorta sounds like "Do you want to share this bug report with Apple?" like share the data with the Viam company

JessamyT · 2025-06-05T22:07:46Z

docs/operate/get-started/other-hardware/cpp-module.md

@@ -1491,7 +1491,7 @@ _Add instructions here for any requirements._

 ## Configure your <INSERT MODEL NAME> <INSERT API NAME>

-Navigate to the **CONFIGURE** tab of your [machine](https://docs.viam.com/fleet/machines/) in the [Viam app](https://app.viam.com/).
+Navigate to the **CONFIGURE** tab of your [machine](https://docs.viam.com/fleet/machines/).


Suggested change

Navigate to the **CONFIGURE** tab of your [machine](https://docs.viam.com/fleet/machines/).

Navigate to your machine's **CONFIGURE** tab.

JessamyT · 2025-06-05T22:12:29Z

docs/operate/reference/architecture/_index.md

@@ -38,11 +38,11 @@ This page provides an overview of how a machine is structured, including on-devi

 When `viam-server` can connect to the cloud, it also:

- Automatically pulls configuration updates you make in the Viam app
+- Automatically pulls configuration updates you make


Suggested change

- Automatically pulls configuration updates you make

- Automatically pulls configuration updates you make in the web UI

JessamyT · 2025-06-05T22:13:59Z

docs/operate/reference/components/arm/ur5e.md

 Click the **+** icon next to your machine part in the left-hand menu and select **Component or service**.
 Select the `arm` type, then select the `ur5e` model.
 Enter a name or use the suggested name for your arm and click **Create**.

-{{<imgproc src="/components/arm/ur5e-ui-config.png" resize="x1100" declaredimensions=true alt="Web UI configuration panel for an arm of model ur5e in the Viam app, with Attributes & Depends On dropdowns and the option to add a frame." style="width:600px" class="imgzoom shadow" >}}
+{{<imgproc src="/components/arm/ur5e-ui-config.png" resize="x1100" declaredimensions=true alt="web UI configuration panel for an arm of model ur5e, with Attributes & Depends On dropdowns and the option to add a frame." style="width:600px" class="imgzoom shadow" >}}


Suggested change

{{<imgproc src="/components/arm/ur5e-ui-config.png" resize="x1100" declaredimensions=true alt="web UI configuration panel for an arm of model ur5e, with Attributes & Depends On dropdowns and the option to add a frame." style="width:600px" class="imgzoom shadow" >}}

{{<imgproc src="/components/arm/ur5e-ui-config.png" resize="x1100" declaredimensions=true alt="Web UI configuration panel for an arm of model ur5e, with Attributes & Depends On dropdowns and the option to add a frame." style="width:600px" class="imgzoom shadow" >}}

[nit]

JessamyT · 2025-06-05T22:14:44Z

docs/operate/reference/components/board/esp32.md


 {{< alert title="Info" color="info" >}}

-The`esp32` [board](/operate/reference/components/board/) model is not currently available as a built-in option in the [Viam app](https://app.viam.com), so you cannot use **Builder** mode to configure this board.
+The`esp32` [board](/operate/reference/components/board/) model is not currently available as when configuring your machine using **Builder** mode.


Suggested change

The`esp32` [board](/operate/reference/components/board/) model is not currently available as when configuring your machine using **Builder** mode.

The`esp32` [board](/operate/reference/components/board/) model is not currently available when configuring your machine using **Builder** mode.

Documentation updates from Promptless

85b89c4

Update

4f2eaca

npentrel marked this pull request as draft June 5, 2025 11:52

npentrel force-pushed the docs-update-d6c436ec-4816-4ef5-9639-4a23bacfb6ee-20250604-080146 branch 2 times, most recently from 214ff6e to f4a87d3 Compare June 5, 2025 11:54

npentrel added 2 commits June 5, 2025 14:01

More changes

da8eb27

Updates

4455a84

npentrel force-pushed the docs-update-d6c436ec-4816-4ef5-9639-4a23bacfb6ee-20250604-080146 branch from f4a87d3 to 4455a84 Compare June 5, 2025 12:30

npentrel added 2 commits June 5, 2025 15:19

Updates

1211c8e

Rest

4c71696

npentrel changed the title ~~docs: Update terminology from "the Viam app" to "Viam" throughout documentation~~ DOCS-4059: Update terminology from Viam app to Viam Jun 5, 2025

npentrel marked this pull request as ready for review June 5, 2025 13:50

npentrel added 2 commits June 5, 2025 15:50

Fix

af32059

Links

89434f6

nathan-contino approved these changes Jun 5, 2025

View reviewed changes

JessamyT reviewed Jun 5, 2025

View reviewed changes

	Navigate to the [DATA](https://app.viam.com/data/view).
	Navigate to [Viam > DATA](https://app.viam.com/data/view).

	Once you have used the data management service to [capture data](/data-ai/capture-data/capture-sync/), you can visualize your data on a dashboard with the TELEOP page or a variety of third-party tools, including Grafana, Tableau, Google's Looker Studio, and more.
	Once you have used the data management service to [capture data](/data-ai/capture-data/capture-sync/), you can visualize your data on a dashboard in [Viam > TELEOP](https://app.viam.com/teleop) or a variety of third-party tools, including Grafana, Tableau, Google's Looker Studio, and more.

	To get started using Viam's SDKs to connect to and control your camera and the rest of your machine, go to your machine's page, navigate to the CONNECT tab's Code sample page, select your preferred programming language, and copy the sample code.
	To get started using Viam's SDKs to connect to and control your camera and the rest of your machine, go to your machine's page, navigate to [Viam > CONNECT > Code sample](https://app.viam.com/connect/code-sample), select your preferred programming language, and copy the sample code.

	1. Navigate to the CONFIGURE tab of one of your machine.
	1. Navigate to the CONFIGURE tab of one of your machines.

	After uploading the training script, you can run it by submitting a training job using the web UI, the CLI or the [ML Training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).
	After uploading the training script, you can run it by submitting a training job using the web UI, the CLI or the [ML training client API](/dev/reference/apis/ml-training-client/#submittrainingjob).

	{{% tab name="web UI" min-height="150px" %}}
	{{% tab name="Web UI" min-height="150px" %}}

	View filtered data on Viam
	View filtered data in the Viam web UI

	If you are adding networks to a machine’s configuration, the machine will need to be connected to the internet to retrieve the configuration information containing the network credentials before it can use them.
	If you are using the web UI to add networks to a machine’s configuration, the machine will need to be connected to the internet to retrieve the configuration information containing the network credentials before it can use them.

	The [Viam mobile app](/manage/troubleshoot/teleoperate/default-interface/#viam-mobile-app) also allows you to test, monitor and remotely operate machines in your fleet.
	Like the web UI, the [Viam mobile app](/manage/troubleshoot/teleoperate/default-interface/#viam-mobile-app) also allows you to test, monitor and remotely operate machines in your fleet.

	`viam-server` connects your machine to Viam and to SDK clients.
	`viam-server` connects your machine to the Viam cloud and to SDK clients.

		If desired, you can configure your module to output log messages to Viam.
		Log messages sent to Viam appear on the [LOGS tab](/manage/troubleshoot/troubleshoot/#check-logs) for your machine in an easily-parsable and searchable manner.

	Navigate to the CONFIGURE tab of your [machine](https://docs.viam.com/fleet/machines/).
	Navigate to your machine's CONFIGURE tab.

	- Automatically pulls configuration updates you make
	- Automatically pulls configuration updates you make in the web UI

	{{<imgproc src="/components/arm/ur5e-ui-config.png" resize="x1100" declaredimensions=true alt="web UI configuration panel for an arm of model ur5e, with Attributes & Depends On dropdowns and the option to add a frame." style="width:600px" class="imgzoom shadow" >}}
	{{<imgproc src="/components/arm/ur5e-ui-config.png" resize="x1100" declaredimensions=true alt="Web UI configuration panel for an arm of model ur5e, with Attributes & Depends On dropdowns and the option to add a frame." style="width:600px" class="imgzoom shadow" >}}

	The`esp32` [board](/operate/reference/components/board/) model is not currently available as when configuring your machine using Builder mode.
	The`esp32` [board](/operate/reference/components/board/) model is not currently available when configuring your machine using Builder mode.

DOCS-4059: Update terminology from Viam app to Viam #4379

Are you sure you want to change the base?

DOCS-4059: Update terminology from Viam app to Viam #4379

Uh oh!

Conversation

promptless bot commented Jun 4, 2025

Uh oh!

viambot commented Jun 4, 2025

Uh oh!

promptless bot commented Jun 4, 2025

Uh oh!

netlify bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for viam-docs ready!

Uh oh!

npentrel commented Jun 4, 2025

Uh oh!

nathan-contino left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

netlify bot commented Jun 4, 2025 •

edited

Loading

nathan-contino left a comment •

edited

Loading