Skip to content

docs(machines): correct machine diagnostics field and blocker details - #1612

Merged
skevetter merged 2 commits into
mainfrom
docs/machine-diagnostics-maintenance
Oct 20, 2026
Merged

skevetter merged 2 commits into
mainfrom
docs/machine-diagnostics-maintenance

Conversation

@skevetter

@skevetter skevetter commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Corrects daemon health, snapshot freshness, blocker, and timeout wording in machine-diagnostics.mdx.
  • States the 20-minute fallback applies only to the inactivity timeout, not auto-stop.
  • Makes the shutdown candidate a machine-level entry.
  • Restores the completion-event note and states health is not shown without a snapshot.

Why

  • degraded is set only by patrol_failed and shutdown_failed (cmd/internal/agent_daemon.go:334, :365).
  • Freshness is stale past max(3 × patrol interval, 90s) (pkg/machinediagnostics/store.go:535-536). No snapshot gives unknown (store.go:319) and no health value (store.go:328-332).
  • The 20-minute default applies when workspace Agent.Timeout is empty (cmd/internal/agent_daemon.go:780-781; pkg/agent/agent.go:26).
  • Auto-stop is blocked when the shutdown command is empty or shutdownAction is none (agent_daemon.go:763-770, :695-696).
  • Completion event is recorded after the shutdown command returns (agent_daemon.go:475-482), so a missing event is consistent with a machine stopped before the write.

Validation

  • Head 6a1faa560, diff vs origin/main: +7/-5, 1 file.
  • npm run build in sites/docs-devsy-sh: exit 0.
  • npm run check-links: 0 errors.
  • prek run --files on the page: pass.

CodeRabbit CLI

  • Run 1 on 5e5d40d: completed, 2 minor findings on the 20-minute wording. Both fixed in 53153d1.
  • Run 2 on 53153d1: not completed, rate limited. Allowed by the maintenance skill.
  • Run 3 on 6a1faa560: completed, 0 findings, reviewed machine-diagnostics.mdx.

Auto-merge

Eligible pending automated gates: CI and CodeRabbit review on head 6a1faa560. No human gate. Not merged, not marked ready, by this worker.

Next

  • Automated CI and CodeRabbit review on head 6a1faa560.
  • Auto-merge per the maintenance skill once gates pass.

Type of change

  • Docs

AI assistance

Haiku worker and Codex coordinator.

Testing

Docs-only change. No integration tests needed. Validated with npm run build, npm run check-links, and prek run --files.

Checklist

  • Code cited for each claim
  • Build, link check, and prek pass
  • Commit signed

@skevetter skevetter added the docs-cleanup Docs cleanup (maintenance bot) label Oct 20, 2026
@netlify

netlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev ready!

Name Link
🔨 Latest commit 6a1faa5
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6ad708882c316bde240b650a
😎 Deploy Preview https://deploy-preview-1612--devsydev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: fa0be245-0997-4830-a453-b76f546bf86f
📥 Commits

Reviewing files that changed from the base of the PR and between c7aecf5 and 6a1faa5.

📒 Files selected for processing: 1
  • sites/docs-devsy-sh/content/docs/managing-machines/machine-diagnostics.mdx

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

📝 Walkthrough

The machine diagnostics documentation updates shutdown eligibility rules, timeout defaults, and the machine-level shutdown candidate. It also clarifies provider state, daemon health, and snapshot freshness definitions.

Changes: Machine diagnostics

Layer / File(s) Summary
Shutdown rules and diagnostic fields
sites/docs-devsy-sh/content/docs/managing-machines/machine-diagnostics.mdx
The documentation lists workspace conditions that block shutdown, describes timeout defaults, and defines the machine-level shutdown candidate. It also clarifies provider-query failures, daemon health degradation, unknown states, and snapshot staleness thresholds.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 6a1fa

This documentation-only change is ready to merge; its shutdown and diagnostic semantics align with the repository evidence.

Architecture risk: 🔵 Low · up to 6a1fa

The change affects 1 system.

Changed systems: sites

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — sites (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in sites/docs-devsy-sh/content/docs/managing-machines/machine-diagnostics.mdx: Updated shutdown rules to require all workspace checks to pass, added blocking conditions, documented timeout defaults, and changed the shutdown candidate from a workspace-level eligibility notice to a machine-level entry based on the latest inactivity deadline.
  • observed — Modified behavior in sites/docs-devsy-sh/content/docs/managing-machines/machine-diagnostics.mdx: Expanded field definitions for provider state, daemon health, and snapshot freshness, including unknown-state handling, failure conditions, and staleness when age exceeds the greater of three patrol intervals or 90 seconds.
Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Description check Warning The description explains the documentation changes, rationale, type, validation, and testing. It does not follow the repository template fully: it omits the required issue reference, leaves the AI ass… Add the Fixes #N, Refs #N, or none entry. Complete the AI assistance section with the tool/model, usage, share of change, and required attestations. Restore or explicitly complete the repository checklist, including lint, test, docs, …
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title is concise, uses Conventional Commits format, and accurately describes the documentation updates to machine diagnostic fields and blocker details.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: Description check

Explanation

The description explains the documentation changes, rationale, type, validation, and testing. It does not follow the repository template fully: it omits the required issue reference, leaves the AI assistance details incomplete, and replaces the required checklist items with a partial custom checklist.

Resolution

Add the Fixes #N, Refs #N, or none entry. Complete the AI assistance section with the tool/model, usage, share of change, and required attestations. Restore or explicitly complete the repository checklist, including lint, test, docs, secrets, and CLA items. Use the template headings, including ## What and why, ## Type of change, ## AI assistance, ## Testing, ## Checklist, and ## Notes for reviewers.}]} прис 天天彩 大发分分彩? no. Need valid JSON. I accidentally included weird? Let's ensure final only JSON. Respond in final. наличии. Check exact field order maybe originalCheckName first according schema but okay. Need no malformed. Let's produce. pak. Wait output has

  • Fix all pre-merge checks with AI
✨ Finishing Touches
✨ Simplify code
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@netlify

netlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 6a1faa5
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6ad70888e7dd63f29607f49e

@skevetter
skevetter marked this pull request as ready for review October 20, 2026 06:58
@skevetter

Copy link
Copy Markdown
Contributor Author

@greptileai review

@mergify

mergify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

@greptile-apps

greptile-apps Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The documentation changes appear safe to merge.

Summary

Updates the machine diagnostics guide to match the daemon and CLI.

  • The guide explains when a machine can stop and what its shutdown candidate means.
  • The guide spells out when diagnostic fields show unknown, degraded, or stale.

Reviews (1) · Last reviewed commit: "docs(machines): restore completion event..." · Reviewed by Greptile

@skevetter
skevetter merged commit b47475c into main Oct 20, 2026
37 checks passed
@skevetter
skevetter deleted the docs/machine-diagnostics-maintenance branch October 20, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-cleanup Docs cleanup (maintenance bot) size/xs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant