Skip to content

Document the AI configuration assistant#5217

Open
btshrewsbury-viam wants to merge 2 commits into
mainfrom
claude/ai-config-assistant
Open

Document the AI configuration assistant#5217
btshrewsbury-viam wants to merge 2 commits into
mainfrom
claude/ai-config-assistant

Conversation

@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator

Closes #5204.

Adds a new how-to page documenting the AI assistant for machine configuration, verified against a live app.viam.com session on 2026-07-15.

New page

docs/hardware/ai-assistant.md — "Configure a machine with the AI assistant" (how-to, with a short explanation of what the assistant does and the review-before-save model). Sections map to the issue's learning objectives:

  • Configure a resource by describing it (Apply)
  • Review each staged edit, then save or discard (Evaluate)
  • Use the assistant on a fragment (Apply)
  • When to use the assistant instead of editing config directly (Analyze)

Placement and discoverability

Placed in the machine-configuration how-to area (docs/hardware/, weight 11, between machine-configuration and fragments). Linked from the section front door configure-hardware.md and from machine-configuration.md so it is discoverable. Additive only; no pages moved, renamed, or deleted.

Fidelity notes

  • Uses the exact verified UI labels: AI assistant, Builder / JSON, Describe a task or ask a question…, Send, New conversation, Conversation history, Collapse, AI assistant feedback, Let's start configuring, What do you want to do?, Unsaved changes, Save, Discard.
  • Documents one current unified assistant across Builder and JSON views (supersedes the earlier separate JSON-mode resource assistant); no version history.
  • Fragment coverage is limited to availability plus standard config-sync propagation; no fragment-specific save UI is narrated (not separately verified live).
  • Follows house style for service personification: mechanical verbs (the assistant "stages", "reads", "proposes", "generates") and user-centered framing (you describe the change; you save or discard).

Checks (run in the worktree)

  • prettier: clean (no changes)
  • markdownlint: pass (0)
  • vale: 0 errors; readability grade 8.22 (below the section's neighbors)

make build-prod was intentionally not run to avoid contending with the coordinator and Netlify builds; the coordinator should confirm the production build and the Netlify deploy preview.

Add a how-to page for configuring a machine with the AI assistant, covering
describing changes, reviewing staged edits, using the assistant on a fragment,
and when to use it versus editing config directly. Link it from the configure
hardware overview and the machine configuration page.
@netlify

netlify Bot commented Jul 15, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit a23d6e9
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a57c4a76c1ac90008eed227
😎 Deploy Preview https://deploy-preview-5217--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: 38 (🔴 down 5 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (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.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jul 15, 2026
@btshrewsbury-viam
btshrewsbury-viam marked this pull request as ready for review July 15, 2026 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the AI configuration assistant (config-level + resource-level)

2 participants