Skip to content

Update machine configuration docs for the stale-config warning - #5458

Merged
Eliza Farley (elizafarley) merged 2 commits into
mainfrom
claude/update-stale-config-warning
Oct 23, 2026
Merged

Eliza Farley (elizafarley) merged 2 commits into
mainfrom
claude/update-stale-config-warning

Conversation

@shannonbradshaw

Copy link
Copy Markdown
Collaborator

Source changes

  • viamrobotics/app#13897: while a machine or fragment config has unsaved edits, the app checks the saved config every 5 seconds. When someone else (or you, in another tab) has saved it, Save is replaced by Config out of date with Review and Discard. Review opens the existing Configuration out of date dialog.

Documents: no ticket key found (the PR title and body carry no Jira key).

Docs changes

  • docs/hardware/machine-configuration.md: under "Editing configuration", describe the out-of-date warning and the dialog's three choices (Merge changes, only when a safe merge is possible; Save anyway; Discard changes and reload). The dialog has existed since app#11749, but no docs page described it. Labels checked against ui/src/lib/components/save-config/save-status-banner.svelte and ui/src/lib/components/save-conflict-modal.svelte.

How I found these

  • Xref lookup: no xref entry covers the config save controls.
  • Grep matches: unsaved changes, out of date, conflict, save anyway, Cmd + S / ⌘/Ctrl+S across docs/, static/, layouts/. No page described concurrent edits. docs/hardware/ai-assistant.md and docs/visualization/3d-scene/editing-frames-visually.md describe Unsaved changes / Save, and they remain correct.

Checks: prettier (repo-local 3.2.5), markdownlint, vale 3.12.0, frontmatter_rules.py, and make build-prod all pass.


Generated by daily docs change agent


Generated by Claude Code

…config

viamrobotics/app#13897 polls the saved config every 5 seconds while a
machine or fragment config has unsaved edits and, when it has moved,
replaces Save with 'Config out of date' plus Review and Discard. Review
opens the existing 'Configuration out of date' dialog (merge, save
anyway, discard and reload), which the docs never described.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U2HGi58Ptr3BMgKuZdhkyy
@netlify

netlify Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit ccef332
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6adb714536d84ce7e51cb800
😎 Deploy Preview https://deploy-preview-5458--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: 43 (🟢 up 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 Oct 23, 2026
@elizafarley

Copy link
Copy Markdown
Contributor

Docs review: Ready to merge

Adds a paragraph and list to docs/hardware/machine-configuration.md describing the out-of-date config warning and the Configuration out of date dialog. Every claim checks out against viamrobotics/app main; only nits below.

CI: All required checks passing

Docs health: No regressions

Nits

  • docs/hardware/machine-configuration.md:120: When a safe merge is possible, the dialog opens on the Merge tab and Save anyway only appears after the reader switches to the Overwrite tab (save-conflict-modal.svelte, footer shows Merge changes when activeTab === 'merge', otherwise Save anyway). As written, a reader looking for Save anyway may not find it. Fix: e.g. "Save anyway: keep your edits and overwrite the other change. When the dialog shows tabs, this is on the Overwrite tab."
  • docs/hardware/machine-configuration.md:115: "The dialog shows who made the other change" holds only when the editor is known; otherwise it shows a generic "changed in another session" message. Fix: "The dialog shows how the saved configuration differs from your edits (and who changed it, when known)".
  • docs-health's uncalibrated ui_score for this page rose 4.0 → 7.9. The new paragraph is a click-by-click UI walkthrough on an explanation page; fine at this size, but if it grows, consider moving it to a how-to.
Verified against source (8 claims)
  • Saved config is checked every 5 seconds while edits are unsaved (PR description): viamrobotics/app ui/src/lib/api/use-config-polling.svelte.ts (intervalMs = 5000, checkIsStale only when isEditing)
  • Save is replaced when stale: ui/src/lib/components/save-config/save-button.svelte (isSaveBlockedByStale hides the button)
  • Banner labels Config out of date, Review, Discard: ui/src/lib/components/save-config/save-status-banner.svelte
  • Fragments behave the same way: ui/src/routes/(auth-required)/(fragments)/fragment/[fragment_id]/+layout.svelte:613 passes isStale and onReviewStaleChanges
  • Your own save from another tab triggers it: save-conflict-modal.svelte (editorName === 'you' → "You made changes … in another session")
  • Dialog title Configuration out of date and a diff of saved vs. your config: save-conflict-modal.svelte
  • Merge changes only offered when merge is safe, on the Merge tab: save-conflict-modal.svelte (showTabs = mergeSafe === true && onMerge !== undefined)
  • Save anyway and Discard changes and reload button labels: save-conflict-modal.svelte footer

Automated review by Claude. Rerunning the review updates this comment.

Copy link
Copy Markdown
Collaborator Author

Applied both wording nits in ccef332: Save anyway now says it is on the Overwrite tab when the dialog shows tabs, and the dialog description says it shows who changed the config only when known. Leaving the paragraph on this page for now, given the size note.


Generated by Claude Code

@elizafarley
Eliza Farley (elizafarley) merged commit be0c594 into main Oct 23, 2026
14 checks passed
@elizafarley
Eliza Farley (elizafarley) deleted the claude/update-stale-config-warning branch October 23, 2026 16:31
@github-actions

Copy link
Copy Markdown

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

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.

4 participants