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

Add safe failure mode documentation #19

New issue
Closed
opened 2026-05-05 02:17:21 -04:00 by JackFrostbyte · 1 comment
JackFrostbyte commented 2026-05-05 02:17:21 -04:00
Owner
Copy link

Title:
Add safe failure mode documentation

Description:
Document the expected safe behavior of RGB Aura during startup, shutdown, interruption, and failure.

Scope:

  • Document what happens if OpenRGB is not running.
  • Document what happens if mapping validation fails.
  • Document what happens on Ctrl+C.
  • Document what zones are allowed to be animated.
  • Document that reserved zones are skipped.
  • Include basic troubleshooting steps.

Acceptance criteria:

  • Documentation explains safe startup/shutdown behavior.
  • Documentation explains how to stop the controller.
  • Documentation explains how to restore dark-blue static state.
  • Documentation is understandable for future maintenance.
Title: Add safe failure mode documentation Description: Document the expected safe behavior of RGB Aura during startup, shutdown, interruption, and failure. Scope: - Document what happens if OpenRGB is not running. - Document what happens if mapping validation fails. - Document what happens on Ctrl+C. - Document what zones are allowed to be animated. - Document that reserved zones are skipped. - Include basic troubleshooting steps. Acceptance criteria: - Documentation explains safe startup/shutdown behavior. - Documentation explains how to stop the controller. - Documentation explains how to restore dark-blue static state. - Documentation is understandable for future maintenance.
JackFrostbyte commented 2026-05-09 21:48:16 -04:00
Author
Owner
Copy link

Completed in PR #37.

Added focused safe failure mode documentation in 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 completed:

ruff format src/rgb_aura scripts tests
ruff check src/rgb_aura scripts tests
Completed in PR #37. Added focused safe failure mode documentation in `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 completed: ```zsh ruff format src/rgb_aura scripts tests ruff check src/rgb_aura scripts tests
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
v1.0
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
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#19
No description provided.