Skip to content

docs: clarify bounded busy recovery - #19

Merged
flowcool merged 3 commits into
V2R1from
docs/busy-recovery-guide
Oct 20, 2026
Merged

flowcool merged 3 commits into
V2R1from
docs/busy-recovery-guide

Conversation

@flowcool

@flowcool flowcool commented Oct 20, 2026 •

Copy link
Copy Markdown
Owner

Behavior

Align the multi-device guide with the merged BUSY recovery budget. The previous paragraph described waiting until BUSY eventually cleared and omitted the terminal reset/emergency sleep path. State the total recovery budget and link its action-versus-physical-sleep limits.

Verification

  • Read the guide against the merged core scripts and docs/display-recovery.md.
  • Documentation-only change. Whitespace, line endings and semantic diff checked. No firmware, builder or device action.
  • Rollback: revert this documentation commit.

AI assistance

Codex reconciled the guide with the reviewed implementation and verified the scope of its timing claim.

CodeRabbit review

Documentation-only follow-up to PR #16. Beads: infra-3rr.60. No firmware change.

Summary by CodeRabbit

  • Bug Fixes

    • Display recovery now reports a clear timeout when the panel remains busy.
    • Recovery retries and delays now share a single 30-second time limit.
    • Normal sleep is deferred during display recovery.
    • Failed recovery safely resets the panel and requests emergency sleep while preserving final shutdown behavior.
  • Documentation

    • Clarified the distinction between initiating sleep and the device physically entering sleep.

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration
  • Configuration used: Repository YAML (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d238ad6b-269c-45c9-9246-e38f3a78b1d4
📥 Commits

Reviewing files that changed from the base of the PR and between f4399bd and 96e87b1.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository YAML (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: e8edef1f-5c12-413c-ba18-fda521451cd1
📥 Commits

Reviewing files that changed from the base of the PR and between 32ecaab and f4e260a.

📒 Files selected for processing: 1
  • examples/multi-device/README.md

Limit details: You’ve used all 10 included reviews currently available.

📜 Recent review details
🔇 Additional comments: 1
examples/multi-device/README.md: 1

129-135: LGTM!

Walkthrough

The multi-device README now describes a 30-second BUSY observation budget, panel reset and emergency sleep when recovery fails, retained native shutdown hooks, and the difference between a bounded sleep action and physical sleep.

Changes

Display recovery documentation

Layer / File(s) Summary
Recovery behavior documentation
examples/multi-device/README.md
The README documents the BUSY timeout, panel reset and emergency sleep request, retained shutdown hooks, and bounded versus physical sleep.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to f4e26

This documentation-only change accurately describes the bounded recovery behavior and is mergeable.

Architecture risk: 🔵 Low · up to f4e26

The change affects 1 system.

Changed systems: examples

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

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

Before / after behavior

  • observed — Modified behavior in examples/multi-device/README.md: Display recovery replaces indefinite refusal of deep sleep and the prior 500 ms retry loop with a single bounded 30-second BUSY-observation budget. Persistent failure now resets the panel and requests emergency sleep while preserving native shutdown hooks and documenting bounded versus physical sleep behavior.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the documentation change: clarifying bounded BUSY recovery behavior.
Description check Passed The description is focused and includes the behavior, verification scope, AI assistance, and rollback details. It does not fully populate the verification command, expected result, observed result, or…
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: Description check

Explanation

The description is focused and includes the behavior, verification scope, AI assistance, and rollback details. It does not fully populate the verification command, expected result, observed result, or CodeRabbit review evidence fields, but it provides enough context for this documentation-only change.

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.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@flowcool
flowcool merged commit ca4ea66 into V2R1 Oct 20, 2026
2 checks passed
@flowcool
flowcool deleted the docs/busy-recovery-guide branch October 20, 2026 14:19
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