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

Add project usage documentation #20

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

Title:
Add project usage documentation

Description:
Add user-facing documentation for running RGB Aura manually and understanding the project structure.

Scope:

  • Explain how to activate the Python virtual environment.
  • Explain how to run mapping validation.
  • Explain how to run individual zone test scripts.
  • Explain how to run the coordinated aurora loop.
  • Explain the purpose of config/device_map.json.
  • Explain the difference between preview, test, and runtime scripts.

Acceptance criteria:

  • README or docs page explains normal usage.
  • Commands are copy-paste-ready.
  • Documentation uses the current project structure.
Title: Add project usage documentation Description: Add user-facing documentation for running RGB Aura manually and understanding the project structure. Scope: - Explain how to activate the Python virtual environment. - Explain how to run mapping validation. - Explain how to run individual zone test scripts. - Explain how to run the coordinated aurora loop. - Explain the purpose of `config/device_map.json`. - Explain the difference between preview, test, and runtime scripts. Acceptance criteria: - README or docs page explains normal usage. - Commands are copy-paste-ready. - Documentation uses the current project structure.
JackFrostbyte commented 2026-05-09 23:07:31 -04:00
Author
Owner
Copy link

Completed and merged in PR for feature/v0.6-issue-20-usage-docs.

Summary:

  • Expanded README.md with project overview, requirements, runtime usage, dry-run usage, runtime config references, systemd reference, and safety references.
  • Added docs/usage.md as the main user-facing usage guide.
  • Completed docs/safe-failure-modes.md after the previous truncated section.
  • Completed docs/systemd-user-service.md after the previous truncated section.
  • Kept this documentation-only:
    • no animation behavior changed;
    • no OpenRGB write behavior changed;
    • runtime guardrails unchanged;
    • dry-run remains hardware-free;
    • reserved ARGB zone remains documented as untouched;
    • optional systemd service remains optional and not auto-installed.

Validation:

  • ruff format src/rgb_aura scripts tests
  • ruff check src/rgb_aura scripts tests

Result:

  • 33 files left unchanged
  • All checks passed!

Closing issue #20.

Completed and merged in PR for `feature/v0.6-issue-20-usage-docs`. Summary: - Expanded `README.md` with project overview, requirements, runtime usage, dry-run usage, runtime config references, systemd reference, and safety references. - Added `docs/usage.md` as the main user-facing usage guide. - Completed `docs/safe-failure-modes.md` after the previous truncated section. - Completed `docs/systemd-user-service.md` after the previous truncated section. - Kept this documentation-only: - no animation behavior changed; - no OpenRGB write behavior changed; - runtime guardrails unchanged; - dry-run remains hardware-free; - reserved ARGB zone remains documented as untouched; - optional systemd service remains optional and not auto-installed. Validation: - `ruff format src/rgb_aura scripts tests` - `ruff check src/rgb_aura scripts tests` Result: - `33 files left unchanged` - `All checks passed!` Closing issue #20.
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#20
No description provided.