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	`3928dcf`
🔍 Latest deploy log	https://app.netlify.com/projects/viam-docs/deploys/684881362a7a13000834929e
😎 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: 47 (🔴 down 3 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.

docs/data-ai/data/export.md

docs/data-ai/data/visualize.md

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.

That's not a link that works and it's not a pattern that we're using elsewhere - so going to stick with it as is I think

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

docs/data-ai/ai/deploy.md

docs/data-ai/ai/train.md

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?

you can do this by reconfiguring the machine with API call so no as is is more accurate

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

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

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

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

no. you can update configurations with API calls.

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

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

docs/dev/reference/apis/fleet.md

Co-authored-by: Jessamy Taylor <[email protected]>

docs/operate/get-started/basics.md

…b6ee-20250604-080146

npentrel · 2025-06-10T19:03:53Z

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.

gotcha I looked at all the comments first and was a bit confused. I'd like to get this PR merged now so I am not going to see this as an opportunity to make this change. You can make a ticket but I'd not like us to spend time on that until we're more on top of prioritiy projects. Thanks!

github-actions · 2025-06-10T19:05:02Z

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

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

docs/data-ai/ai/create-dataset.md Outdated Show resolved Hide resolved

JessamyT reviewed Jun 5, 2025

View reviewed changes

npentrel reviewed Jun 10, 2025

View reviewed changes

docs/dev/reference/apis/fleet.md Outdated Show resolved Hide resolved

Apply suggestions from code review

0820997

Co-authored-by: Jessamy Taylor <[email protected]>

npentrel reviewed Jun 10, 2025

View reviewed changes

docs/operate/get-started/basics.md Outdated Show resolved Hide resolved

npentrel added 2 commits June 10, 2025 20:52

Update docs/operate/get-started/basics.md

431a207

Merge branch 'main' into docs-update-d6c436ec-4816-4ef5-9639-4a23bacf…

3928dcf

…b6ee-20250604-080146

npentrel merged commit c910f0d into main Jun 10, 2025
13 checks passed

npentrel deleted the docs-update-d6c436ec-4816-4ef5-9639-4a23bacfb6ee-20250604-080146 branch June 10, 2025 19:04

	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.

	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.

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

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

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

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!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

npentrel commented Jun 10, 2025

Uh oh!

Uh oh!

github-actions bot commented Jun 10, 2025

Uh oh!

Uh oh!

netlify bot commented Jun 4, 2025 •

edited

Loading

nathan-contino left a comment •

edited

Loading