jeans/WLED

mirror of https://github.com/wled/WLED.git synced 2026-04-20 14:12:55 +00:00

Files

Frank Möhle 2302863386 copilot-instructions rework, new C++ coding guide for AI reviews (#5480 )

* comprehensive C++, Web UI, and CI/CD conventions, a condensed setup/build guide, and a new agent-mode build/test workflow with ordered commands, timeouts, validation gates, manual web validation, and troubleshooting steps.

* repository-level AI review/configuration rules, workflow best-practices, safeguards to detect and flag edits to generated web assets, and alignment checks linking AI-facing rules with human-only reference sections.

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

2026-04-08 21:06:48 +02:00

929 B

Raw Blame History

applyTo

applyTo
wled00/data/**

Web UI Coding Conventions

Formatting

Indent HTML and JavaScript with tabs
Indent CSS with tabs

JavaScript Style

camelCase for functions and variables: gId(), selectedFx, currentPreset
Abbreviated helpers are common: d for document, gId() for getElementById()

Key Files

index.htm — main interface
index.js — functions that manage / update the main interface
settings*.htm — configuration pages
*.css — stylesheets (inlined during build)
common.js — helper functions

Reuse shared helpers from common.js whenever possible instead of duplicating utilities in page-local scripts.

Build Integration

Files in this directory are processed by tools/cdata.js into generated headers (wled00/html_*.h, wled00/js_*.h). Run npm run build after any change. Never edit generated headers directly.

929 B Raw Blame History