JackFrostbyte/rgb-aura
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Document safe failure modes #37

Merged
JackFrostbyte merged 1 commit from feature/v0.6-issue-19-safe-failure-docs into main 2026-05-09 21:47:35 -04:00
Conversation 0 Commits 1 Files changed 1 +76
JackFrostbyte commented 2026-05-09 21:47:07 -04:00
Owner
Copy link

Summary

Documents the safe failure behavior currently implemented in RGB Aura.

Adds docs/safe-failure-modes.md covering:

  • runtime guardrails
  • runtime configuration validation failures
  • device mapping validation failures
  • reserved ARGB zone protection
  • dry-run hardware-free behavior
  • OpenRGB unavailable startup retry behavior
  • OpenRGB runtime disconnect handling
  • dark-blue shutdown restore behavior
  • logging behavior
  • known expected exit codes

Validation

Documentation-only change.

Validated with:

ruff format src/rgb_aura scripts tests
ruff check src/rgb_aura scripts tests
## Summary Documents the safe failure behavior currently implemented in RGB Aura. Adds `docs/safe-failure-modes.md` covering: - runtime guardrails - runtime configuration validation failures - device mapping validation failures - reserved ARGB zone protection - dry-run hardware-free behavior - OpenRGB unavailable startup retry behavior - OpenRGB runtime disconnect handling - dark-blue shutdown restore behavior - logging behavior - known expected exit codes ## Validation Documentation-only change. Validated with: ```zsh ruff format src/rgb_aura scripts tests ruff check src/rgb_aura scripts tests
JackFrostbyte deleted branch feature/v0.6-issue-19-safe-failure-docs 2026-05-09 21:47:35 -04:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
JackFrostbyte/rgb-aura!37
No description provided.