Add user_fx installation instructions and a usermod config example#5327
Open
gustebeast wants to merge 4 commits intowled:mainfrom
Open
Add user_fx installation instructions and a usermod config example#5327gustebeast wants to merge 4 commits intowled:mainfrom
gustebeast wants to merge 4 commits intowled:mainfrom
Conversation
Contributor
WalkthroughAdds an Installation section and navigation entries to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@usermods/user_fx/README.md`:
- Around line 18-22: Update the Installation section to show the setting as an
.ini code block and demonstrate both the simple add and the safe append case so
users don't overwrite existing usermods; explicitly reference the
platformio_override.ini key name custom_usermods and the usermod name user_fx,
show the single-entry example (custom_usermods = user_fx) inside an ini block,
and add a second ini block showing how to append to an existing list (e.g.,
custom_usermods = user_v2, user_fx).
0235b62 to
ff351a1
Compare
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
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.
When I was getting started I had trouble with WLED information referencing old methods for installing usermods. Since user_fx is a form of example/getting started effect it seems worth explaining the process again to be clear.
I also just had difficulty figuring out how to read usermod config values from my effect function, and having an example for that would have helped a lot.
Summary by CodeRabbit
Documentation
Chores