Skip to content

Monitor and operate section: complete rewrite#4885

Merged
shannonbradshaw merged 1 commit intoviamrobotics:new-docs-sitefrom
shannonbradshaw:content/monitor
Apr 7, 2026
Merged

Monitor and operate section: complete rewrite#4885
shannonbradshaw merged 1 commit intoviamrobotics:new-docs-sitefrom
shannonbradshaw:content/monitor

Conversation

@shannonbradshaw
Copy link
Copy Markdown
Collaborator

Summary

  • Writes the complete Monitor and Operate section (9 content pages + 2 nav nodes)
  • Replaces stub pages with full content based on Section Review playbook (Phases 1-4)
  • Restructures dashboards into a subsection with overview, how-to, and custom queries pages
  • Adds alias redirects for all old paths under manage/troubleshoot/

Pages

Page Type Content
Section overview Explanation Orients users to all monitoring/operating capabilities
Monitor machine status How-to Fleet dashboard, part status, CLI commands, mobile app
Data dashboards overview Explanation Widget types, windowing/aggregation query model, dashboard vs teleop comparison
Create dashboards How-to Create dashboards, add and configure widgets, filters
Custom queries How-to MQL aggregation pipelines for advanced visualizations
Set up alerts How-to Telemetry, log, and online/offline triggers with frequency guidance
Default control interface How-to CONTROL tab (18 resource types) and Viam mobile app
Teleop workspaces How-to Custom operator interfaces with focused widget views
Troubleshoot problems How-to Logs, remote shell, debug endpoints, FTDC, traces, restart, config history

Key decisions

  • Dashboard content split into subsection: overview (explains query model), create (how-to), custom queries (MQL). Resolves confusion around windowing and aggregation.
  • Widget types documented once in the dashboards overview, cross-referenced from create-dashboards and teleop-workspaces.
  • Alert page renamed from "Alert on machine telemetry" to "Set up alerts" (covers logs and status, not just telemetry).
  • Teleop split into default interface (CONTROL tab) and teleop workspaces (custom views).
  • Previously undocumented features added: FTDC diagnostics, OpenTelemetry traces, CLI trigger management, Explain Error AI.
  • Cross-section boundaries: links to data triggers, vision alerts, data visualization, common errors. No content duplication.

Test plan

  • All pages render at expected paths in deploy preview
  • Alias redirects resolve (manage/troubleshoot/*, fleet/control, build/configure/triggers, etc.)
  • Nav structure displays correctly with dashboards subsection
  • Cross-section links resolve
  • Review dashboard query model explanation for clarity

🤖 Generated with Claude Code

Write the complete Monitor and Operate section from scratch:
- Section overview explaining all monitoring/operating capabilities
- Monitor machine status: fleet dashboard, part status, CLI commands
- Data dashboards subsection with overview (widget types, query model),
  create dashboards (how-to), and custom queries (MQL pipelines)
- Set up alerts: telemetry, logs, online/offline triggers with
  alert frequency guidance
- Default control interface: CONTROL tab and mobile app
- Teleop workspaces: custom operator interfaces
- Troubleshoot problems: logs, remote shell, debug endpoints,
  FTDC, traces, restart, config history

Restructures from stub pages based on Section Review playbook:
Phase 1 (problem landscape research, feature inventory, vocabulary),
Phase 2 (IA evaluation, user journey analysis), Phase 3 (accuracy
assessment of existing dashboards page), Phase 4 (write all pages).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 7, 2026

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit b677403
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/69d58597199af800082c41f5
😎 Deploy Preview https://deploy-preview-4885--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 37 (🔴 down 6 from production)
Accessibility: 99 (🔴 down 1 from production)
Best Practices: 100 (no change from production)
SEO: 89 (🔴 down 3 from production)
PWA: 60 (🔴 down 10 from production)
View the detailed breakdown and full score reports

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

@shannonbradshaw shannonbradshaw merged commit c32104b into viamrobotics:new-docs-site Apr 7, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant