More usermod doc tweaks#331
Merged
Merged
Conversation
GitHub doesn't support multiple forks of the same repo, so instead the example usermod should be used as a template.
Symlink instructs PlatformIO to track changes.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughThis PR adds a prominent community-use warning and a License column to the community usermods index, and updates the usermod development guide to prefer template-based repos and symlink-based local development paths. ChangesUsermod Documentation Improvements
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/advanced/community-usermods.md`:
- Around line 9-31: The warning blanket currently states all listed usermods are
community-maintained but the table includes an official module (`user_fx` by
`@wled`) and the example template (`wled-usermod-example`), so update the text to
scope the warning to third-party usermods only: either change the heading/body
to say "third-party usermods" and ensure official entries like `user_fx` are
exempt, or move official entries (`user_fx`, `wled-usermod-example`) into a
separate "Official/Included modules" section and keep the warning box above the
third-party list; update any wording that implies the project doesn't maintain
those specific official modules accordingly.
In `@docs/advanced/custom-features.md`:
- Around line 66-76: Update the Windows symlink URI example in the docs to use
the correct PlatformIO format with two slashes
(symlink://C:/Users/you/projects/my-wled-usermod) instead of the triple-slash
form; leave the POSIX example (`symlink:///home/you/projects/my-wled-usermod`)
unchanged so the `platformio_override.ini` snippet and the explanatory sentence
reflect the proper `symlink://<path>` syntax.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 96a562c9-73e3-4219-a960-47cbe84633ce
📒 Files selected for processing (2)
docs/advanced/community-usermods.mddocs/advanced/custom-features.md
Comment on lines
+9
to
+31
| !!! warning "Community content — use at your own risk" | ||
| The usermods listed below are created and maintained by community members, **not** the WLED development team. | ||
| **The WLED project does not review, test, endorse, or provide support for any of these modules.** | ||
|
|
||
| Open a pull request to [WLED-Docs](https://github.com/wled/WLED-Docs) adding a row to the table below. One row, one PR. | ||
| Usermods are native C++ code compiled directly into your WLED firmware. A usermod runs with | ||
| **full, unrestricted access** to your device's hardware, network, and memory — there is no | ||
| sandbox or permission system to limit what it can do. Before installing a third-party build: | ||
|
|
||
| - **Read the source code** (or have someone you trust read it) before flashing. | ||
| - Be aware that a malicious or poorly written usermod could expose your network, **brick your | ||
| device**, or behave in ways its description does not mention. | ||
| - Only flash firmware from sources you trust. Prefer builds you compile yourself from | ||
| reviewed source code over pre-compiled binaries distributed by strangers. | ||
|
|
||
| The WLED project cannot verify the safety or quality of community usermods. | ||
| **You are solely responsible for any third-party code you choose to run on your devices.** | ||
|
|
||
| ## Index | ||
|
|
||
| | Name | Description | Author | Platforms | License | Notes | | ||
| |---|---|---|---|---|---| | ||
| | [wled-usermod-example](https://github.com/wled/wled-usermod-example) | Annotated template — use as template to start your own usermod | @wled | both | EUPL | Official starting point | | ||
| | [user_fx](https://github.com/wled/WLED/tree/main/usermods/user_fx) | Community effects usermod — add your own effects here or use as a template | @wled | both | EUPL | Ships with WLED; enable with `custom_usermods = user_fx` | |
Contributor
There was a problem hiding this comment.
Scope the warning to third-party usermods.
The box says every usermod below is community-maintained, but Line 31 also lists user_fx, which is marked as shipping with WLED and authored by @wled. Narrow the warning or split the official example out so the statement stays accurate.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/advanced/community-usermods.md` around lines 9 - 31, The warning blanket
currently states all listed usermods are community-maintained but the table
includes an official module (`user_fx` by `@wled`) and the example template
(`wled-usermod-example`), so update the text to scope the warning to third-party
usermods only: either change the heading/body to say "third-party usermods" and
ensure official entries like `user_fx` are exempt, or move official entries
(`user_fx`, `wled-usermod-example`) into a separate "Official/Included modules"
section and keep the warning box above the third-party list; update any wording
that implies the project doesn't maintain those specific official modules
accordingly.
netmindz
approved these changes
Jun 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit