Document full portable Aura Creation Studio workflow #95

New issue

Open

opened 2026-05-23 01:09:39 -04:00 by JackFrostbyte · 0 comments

JackFrostbyte commented

2026-05-23 01:09:39 -04:00

Owner

Objective

Document the full portable LLM-assisted Aura Creation Studio workflow.

Scope

Create user-facing documentation that explains the complete flow:

Discover OpenRGB devices.
Create a device profile.
Create an aura profile.
Add physical layout and directional-flow hints.
Generate a machine-specific prompt package.
Send the prompt package to an LLM.
Save the returned JSON animation pack.
Validate the pack.
Dry-run or preview the pack.
Run the pack safely with RGB Aura.

Documentation requirements

The documentation should clearly explain:

RGB Aura uses data-only animation packs.
LLMs should not generate Python plugins.
The schema is the contract.
Validation is required before runtime.
Reserved zones must remain protected.
User-assisted layout mapping is expected.
Automatic perfect physical detection is not promised.

Acceptance criteria

Full portable workflow documentation exists.
Documentation includes example commands.
Documentation explains common failure cases.
Documentation links to architecture, schema, validator, and prompt-package docs.
v1.2.0 is ready to close when implementation and docs are complete.

# Objective Document the full portable LLM-assisted Aura Creation Studio workflow. # Scope Create user-facing documentation that explains the complete flow: 1. Discover OpenRGB devices. 2. Create a device profile. 3. Create an aura profile. 4. Add physical layout and directional-flow hints. 5. Generate a machine-specific prompt package. 6. Send the prompt package to an LLM. 7. Save the returned JSON animation pack. 8. Validate the pack. 9. Dry-run or preview the pack. 10. Run the pack safely with RGB Aura. # Documentation requirements The documentation should clearly explain: - RGB Aura uses data-only animation packs. - LLMs should not generate Python plugins. - The schema is the contract. - Validation is required before runtime. - Reserved zones must remain protected. - User-assisted layout mapping is expected. - Automatic perfect physical detection is not promised. # Acceptance criteria - Full portable workflow documentation exists. - Documentation includes example commands. - Documentation explains common failure cases. - Documentation links to architecture, schema, validator, and prompt-package docs. - v1.2.0 is ready to close when implementation and docs are complete.

JackFrostbyte added reference develop

2026-05-23 01:09:41 -04:00

JackFrostbyte added this to the v1.2.0 — Portable LLM-assisted Aura Creation Studi milestone

2026-05-23 01:09:44 -04:00

JackFrostbyte added a new dependency

2026-05-23 01:10:02 -04:00

#87 Design portable Aura Creation Studio setup workflow

JackFrostbyte added a new dependency

2026-05-23 01:10:07 -04:00

#88 Add OpenRGB device discovery report command

JackFrostbyte added a new dependency

2026-05-23 01:10:11 -04:00