DOCS-3158: document updated table widget, and also all other viz widgets #4420

nathan-contino · 2025-06-27T22:21:36Z

Adds documentation for various undocumented widgets in the TELEOP page.

netlify · 2025-06-27T22:21:43Z

✅ Deploy Preview for viam-docs ready!

Name	Link
🔨 Latest commit	`c419460`
🔍 Latest deploy log	https://app.netlify.com/projects/viam-docs/deploys/6862d8c91f218b0008cdc72e
😎 Deploy Preview	https://deploy-preview-4420--viam-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 43 (🔴 down 10 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.

JessamyT

Most of my comments are predicated on the understanding that we are going for fewer screenshots, not more, for shorter page, lower maintenance burden, and smaller docs repo size. So I recommend taking out all of the ones that just show configuration, and leave only the ones that let you see what each option is. Maybe I missed a convo though?

FWIW they do look pretty and I'm sure some subset of users would find it reassuring to follow along with them all, it just makes it a v long page to scroll through, and harder to quickly refer to the widget types.

docs/data-ai/data/visualize.md

JessamyT · 2025-06-27T22:30:00Z

docs/data-ai/data/visualize.md

+
+For example, the following image shows a time series graph measuring noise over time for a sensor component:
+
+{{<imgproc src="/services/data/visualize-widget-time-series.png" alt="Time series widget measuring noise over time." style="width:700px" resize="1200x" class="imgzoom fill shadow" >}}


isn't this one redundant with widget types below which shows the time series widget?

Yes. But this image is used elsewhere, so I can't delete it, and I'm trying to get the point across that users can add one or many components. That might be obvious to those of us who have used this section before, but for a new user, it's a useful piece of information IMO.

No need to delete the image file but the wording around this is a bit confusing now--it says click and drag to arrange, and then shows this before the multi-widget example. If you don't want to remove, how about moving this to the top of the page (and making it small) for a quick visual of what they'll be able to make?

Looks like nothing has changed here since last review?

updated the ordering

Ooh so you decided to keep this here in the steps just in a very slightly different spot--didn't realize. I do still think it adds clutter and now after the 2 steps everything is un-indented, so I would recommend changing this per comment (I think it makes more sense smaller and in intro), but won't block

docs/data-ai/data/visualize.md

Co-authored-by: Naomi Pentrel <[email protected]>

nathan-contino · 2025-06-30T14:22:08Z

@JessamyT addressed all of your concerns, thanks for the feedback. Please take another look when you get the chance.

docs/data-ai/data/visualize.md

JessamyT · 2025-06-30T16:38:38Z

docs/data-ai/data/visualize.md

+
+For example, the following image shows a time series graph measuring noise over time for a sensor component:
+
+{{<imgproc src="/services/data/visualize-widget-time-series.png" alt="Time series widget measuring noise over time." style="width:700px" resize="1200x" class="imgzoom fill shadow" >}}


No need to delete the image file but the wording around this is a bit confusing now--it says click and drag to arrange, and then shows this before the multi-widget example. If you don't want to remove, how about moving this to the top of the page (and making it small) for a quick visual of what they'll be able to make?

docs/data-ai/data/visualize.md

JessamyT · 2025-06-30T16:42:45Z

docs/data-ai/data/visualize.md


-Your dashboard now shows the configured widget for the data from your machine.
-For example, a time series graph measuring noise over time for a sensor component:
+1. To arrange widgets on your workspace, click and drag the grid icon in the top left of your widget:


I think it'd make more sense to move this step to after you introduce multiple widgets

Since you can arrange even a single widget, I think it's fine here.

I tried doing it and I couldn't get any changes to happen--it still takes up the whole screen. What does it mean to arrange a single widget?

This also applies to adding a widget to an existing dashboard. But sure, I'll move that instruction.

docs/data-ai/data/visualize.md

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

nathan-contino · 2025-06-30T17:12:24Z

@JessamyT implemented your changes. Please take a look when you get the chance and let me know which of the remaining changes must be implemented to reach approval. I'd like to prevent us from circling back to the same points repeatedly to keep this moving.

docs/data-ai/data/visualize.md

JessamyT · 2025-06-30T17:52:57Z

docs/data-ai/data/visualize.md

+
+For example, the following image shows a time series graph measuring noise over time for a sensor component:
+
+{{<imgproc src="/services/data/visualize-widget-time-series.png" alt="Time series widget measuring noise over time." style="width:700px" resize="1200x" class="imgzoom fill shadow" >}}


Looks like nothing has changed here since last review?

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

nathan-contino · 2025-06-30T18:04:38Z

@JessamyT updated again as per your requests

JessamyT

LGTM % 2 comments from previous round that I stand by but won't block on

JessamyT · 2025-06-30T18:21:50Z

docs/data-ai/data/visualize.md

+
+For example, the following image shows a time series graph measuring noise over time for a sensor component:
+
+{{<imgproc src="/services/data/visualize-widget-time-series.png" alt="Time series widget measuring noise over time." style="width:700px" resize="1200x" class="imgzoom fill shadow" >}}


Ooh so you decided to keep this here in the steps just in a very slightly different spot--didn't realize. I do still think it adds clutter and now after the 2 steps everything is un-indented, so I would recommend changing this per comment (I think it makes more sense smaller and in intro), but won't block

JessamyT · 2025-06-30T18:25:18Z

docs/data-ai/data/visualize.md

+
+To arrange widgets on your workspace, click and drag the grid icon in the top left of your widget:
+
+{{<imgproc src="/services/data/visualize-widget-move.png" alt="Click the grid icon to move a widget." style="width:500px" resize="1200x" class="imgzoom fill shadow" >}}


I stand by prev comment that at least for me when testing in app, dragging a single widget does nothing so it'd make more sense to show this on multiple, and could crop multiple-widget image to zoom in slightly on this UI element.

github-actions · 2025-06-30T18:38:48Z

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

DOCS-3158: document updated table widget, and also all other viz widgets

80ca037

viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jun 27, 2025

JessamyT requested changes Jun 27, 2025

View reviewed changes

nathan-contino added 2 commits June 30, 2025 09:13

Update according to review feedback

3885249

Fix consecutive blank lines

81e985e

npentrel reviewed Jun 30, 2025

View reviewed changes

docs/data-ai/data/visualize.md Outdated Show resolved Hide resolved

Update docs/data-ai/data/visualize.md

010eee1

Co-authored-by: Naomi Pentrel <[email protected]>

JessamyT reviewed Jun 30, 2025

View reviewed changes

Apply suggestions from code review

0e7a30d

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

JessamyT reviewed Jun 30, 2025

View reviewed changes

docs/data-ai/data/visualize.md Outdated Show resolved Hide resolved

JessamyT reviewed Jun 30, 2025

View reviewed changes

nathan-contino and others added 5 commits June 30, 2025 14:01

Update docs/data-ai/data/visualize.md

9617ee5

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

Update docs/data-ai/data/visualize.md

0922810

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

Update docs/data-ai/data/visualize.md

e988964

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

Update docs/data-ai/data/visualize.md

d5f063a

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

update

6ceeb16

JessamyT approved these changes Jun 30, 2025

View reviewed changes

nathan-contino added 2 commits June 30, 2025 14:34

Remove example

12cb33b

Merge branch 'main' into DOCS-3158-visualization-teleop

c419460

nathan-contino merged commit 8399e12 into viamrobotics:main Jun 30, 2025
12 checks passed

nathan-contino deleted the DOCS-3158-visualization-teleop branch June 30, 2025 18:38


		For example, the following image shows a time series graph measuring noise over time for a sensor component:

		{{<imgproc src="/services/data/visualize-widget-time-series.png" alt="Time series widget measuring noise over time." style="width:700px" resize="1200x" class="imgzoom fill shadow" >}}


		To arrange widgets on your workspace, click and drag the grid icon in the top left of your widget:

		{{<imgproc src="/services/data/visualize-widget-move.png" alt="Click the grid icon to move a widget." style="width:500px" resize="1200x" class="imgzoom fill shadow" >}}

DOCS-3158: document updated table widget, and also all other viz widgets #4420

DOCS-3158: document updated table widget, and also all other viz widgets #4420

Conversation

nathan-contino commented Jun 27, 2025

Uh oh!

netlify bot commented Jun 27, 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!

JessamyT 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!

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!

Uh oh!

Uh oh!

Uh oh!

nathan-contino commented Jun 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nathan-contino commented Jun 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nathan-contino commented Jun 30, 2025

Uh oh!

JessamyT left a comment

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!

github-actions bot commented Jun 30, 2025

Uh oh!

Uh oh!

netlify bot commented Jun 27, 2025 •

edited

Loading

JessamyT left a comment •

edited

Loading