Add v16.0.0 documentation updates#323
Open
netmindz wants to merge 16 commits into
Open
Conversation
- New pages: PixelForge, Particle System, Custom Fonts, ESPNow Remotes, Pin Info, Boot-loop Recovery - Update effects.md with 36 new v16 effects - Update palettes.md with new editor and 800+ cpt-city palettes (100+ custom) - Update segments.md with segment layering, blend modes, and transition blending - Update macros.md with 32-button support - Update json-api.md with device_id, PSRAM, repo fields and random colour support - Update mqtt.md with mDNS broker discovery - Update HUB75.md to note official mainline inclusion in v16 - Update roadmap.md to reflect v16 release - Register all new pages in mkdocs.yml nav
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughDocumentation updates announcing WLED v16.0.0: new release note, new pages (boot-loop recovery, custom fonts, particle system, Pin Info, PixelForge), audio-reactive overhaul, feature doc updates (segments/effects/palettes/macros/HUB75), interface docs (ESPNow/JSON/MQTT/DMX/IR), and MkDocs nav additions. ChangesWLED v16.0.0 Documentation Release
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
Collaborator
|
good starting point, there are some slight inaccuracies or places where additional info would be useful. I need to check if I can push to this PR directly, not sure I have my repo set up to do that. |
netmindz
commented
May 17, 2026
| @@ -0,0 +1,65 @@ | |||
| --- | |||
| title: Custom Fonts | |||
|
|
||
| As of 0.14, up to 10 custom palettes can be uploaded by the user in JSON files named `palette0.json` through `palette9.json` | ||
| The format closely resembles that of the palettes defined in `palettes.h` with a position (0-255), red, green, blue for each color. An example of the content would be: | ||
| As of v0.14, up to 10 custom palettes can be uploaded in JSON files. Starting in **v0.16**, over **100 custom palettes** are supported, and the JSON naming scheme has changed — palettes are no longer limited to `palette0.json` through `palette9.json`. |
| @@ -0,0 +1,70 @@ | |||
| --- | |||
| title: Particle System | |||
| @@ -0,0 +1,70 @@ | |||
| --- | |||
| title: PixelForge (Image & GIF Tool) | |||
| ~~btype~~ | string | The origin of the build. `src` if a release version is compiled from source, `bin` for an official release image, `dev` for a development build (regardless of src/bin origin) and `exp` for experimental versions. `ogn` if the image is flashed to hardware by the vendor. _Removed as of v0.10_ | ||
| mac | string | The hexadecimal hardware MAC address of the light, lowercase and without colons. | ||
| ip | string | The IP address of this instance. Empty string if not connected. (since 0.13.0) | ||
| device_id | string | A unique identifier for the device, derived from the hardware MAC address. _(available since 0.16.0)_ |
Member
Author
You should have permissions to clone and push as I added to the main repo rather than my fork |
…ents - Rewrite page for accuracy and readability (ESP support table, mic ordering) - Add Configuration section covering Squelch, Gain, AGC (Off/Normal/Vivid/Lazy) - Add First-Time Setup how-to guide using *Gravimeter effect - Add analog GPIO pin recommendations (GPIO 36; avoid ADC2) - Add reset warning for mic type changes (ESP32 I2S hardware limitation) - Add Audio Reactive Palettes section (Ratio, Hue, Spectrum) - Expand Audio Sync section: UDP multicast details, WMM tip, PC tools table - Fix contributors.md repo URL (Aircoookie → wled)
netmindz
commented
May 17, 2026
| @@ -7,76 +7,172 @@ hide: | |||
|
|
|||
| ## What is Audio Reactive WLED? | |||
Member
Author
There was a problem hiding this comment.
@softhack007 - I have tried to pull over some of the info from MM without going too overboard
Member
There was a problem hiding this comment.
@netmindz reviewed 👍 I've pushed a few corrections and added links to MM for more details.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 10
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/features/palettes.md (1)
97-106:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd a language hint to the fenced JSON example.
This block is missing a language identifier, which trips linting and reduces readability.
Suggested fix
-``` +```json {"palette":[ 0, 255, 33, 4, 43, 255, 68, 25, @@ - 255, 87, 255, 65]} -``` + 255, 87, 255, 65]} +```As per coding guidelines "Use fenced code blocks with language hints (e.g.,
```yaml) for code examples".🤖 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/features/palettes.md` around lines 97 - 106, The fenced code block showing the JSON palette is missing a language hint; update the fenced block around the JSON object (the block starting with {"palette":[ ... 255, 87,255,65]}) to include a JSON language identifier (```json) on the opening fence so linters and renderers treat it as JSON and improve readability.
🧹 Nitpick comments (3)
docs/features/pixelforge.md (1)
7-7: ⚡ Quick winUse MkDocs admonitions for notes.
Please convert
**Note:**blocks to!!! info/!!! warningcallouts.As per coding guidelines: "Use MkDocs Material admonitions (
!!! info,!!! tip,!!! warning,!!! danger) for callouts instead of other formatting methods".Also applies to: 48-48
🤖 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/features/pixelforge.md` at line 7, Replace the bold "**Note:**" callout in the pixelforge feature doc with a MkDocs Material admonition: change the line starting with "**Note:** the gif image player..." to an "!!! info" (or "!!! warning" if you deem it cautionary) block and move the sentence text inside that admonition; apply the same replacement for the second instance referenced (the other occurrence at the later line) so both notes use MkDocs admonition syntax.docs/features/custom-fonts.md (1)
22-22: ⚡ Quick winUse MkDocs admonitions for notes instead of bold “Note:” labels.
Please convert these callouts to
!!! info/!!! tipblocks for consistency with the docs theme.Suggested change
-**Note:** if you want the classic pre 16.0 fonts there is a button available in PixelForge Scrolling Text tab to download "Classic WLED Fonts" as custom fonts. Make sure you do not have any additional custom fonts installed. After downloading, enable the "Custom Font" checkmark. +!!! info + If you want the classic pre-16.0 fonts, use the button in the PixelForge Scrolling Text tab to download **Classic WLED Fonts** as custom fonts. Make sure you don't have additional custom fonts installed. After downloading, enable the **Custom Font** checkmark. ... -**Note:** a single symbol or letter in a font is also referred to as a "glyph" - a typographical character. +!!! info + A single symbol or letter in a font is called a **glyph**.As per coding guidelines: "Use MkDocs Material admonitions (
!!! info,!!! tip,!!! warning,!!! danger) for callouts instead of other formatting methods".Also applies to: 53-53
🤖 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/features/custom-fonts.md` at line 22, Replace the inline bold "Note:" callout with a MkDocs Material admonition by converting the sentence starting "Note: if you want the classic pre 16.0 fonts..." into an admonition block (e.g., start the block with "!!! tip" or "!!! info" and put the existing text as the block body), and make the same change for the other instance referenced around the later occurrence; ensure you remove the bold markup and keep the original wording and punctuation intact inside the admonition.docs/interfaces/espnow.md (1)
62-62: ⚡ Quick winUse consistent version format.
The version should be formatted as "v0.16.0" to match the format used throughout the rest of the documentation and PR.
📝 Proposed fix
-Codes 20–22 were added in v16.0 +Codes 20–22 were added in v0.16.0🤖 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/interfaces/espnow.md` at line 62, Update the version string "v16.0" to the consistent format "v0.16.0" in the line containing "Codes 20–22 were added in v16.0" in docs/interfaces/espnow.md; search for any other occurrences of "v16.0" in that document and replace them with "v0.16.0" so the file matches the rest of the documentation's version formatting.
🤖 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/features/custom-fonts.md`:
- Line 6: Fix user-facing capitalization/typos in docs: in
docs/features/custom-fonts.md update "github" to "GitHub" in the sentence
starting "The source code of the tool..." and correct any occurrences of
"extenstion" to "extension"; then scan all markdown files under docs/ to
normalize capitalization for programming language names (e.g., "JavaScript",
"TypeScript", "Python") and API/data-type names (e.g., "JSON", "HTTP", "UUID")
so they use their standard, correct capitalization consistently.
- Around line 57-63: The ordered list in the markdown restarts numbers
mid-sequence; renumber the items so they are monotonic (1..7) and fix the typo
"extenstion"→"extension": set the items to: 1. Load a source font, 2. Choose
whether to use variable or fixed glyph width, 3. Adjust the three sliders..., 4.
Choose which UTF-8 extension to include..., 5. Set the pixel height..., 6. Edit
individual glyphs..., 7. Click Upload to save or Download to store; update the
list entries that currently read "3. Adjust..." and the later "2. Choose
which..." and "3. Set the pixel height" to these correct sequential numbers.
In `@docs/features/palettes.md`:
- Line 110: The heading "### Additional Palettes (v16.0+)" is using a
third-level heading but should be a top-level section within this page; change
that heading to use "## Additional Palettes (v16.0+)" so it follows the
project's heading hierarchy rules (use ## for top-level sections, ### for
subsections).
In `@docs/features/particle-system.md`:
- Line 9: Replace incorrect terminology in the particle-system docs: change
"undeterministic" to "non-deterministic" in the sentence describing PS effects
and change any occurrences of "quared-distance" to "squared-distance"; ensure
the same fixes are applied at the other occurrence noted (line 26) so both
instances use the correct terms and spelling.
- Line 71: Replace the vague link text "[here](/features/effects)" with a
descriptive phrase like "effect slider reference" in the particle-system.md
sentence so the link reads something like "A description of what each
slider/checkmark does for each effect is described in the effect slider
reference." Locate and update the markdown line containing the link to use the
new descriptive link text.
In `@docs/features/pixelforge.md`:
- Line 69: Update the documentation line that references the custom font file
extension in the Scrolling Text feature: replace the incorrect `.wbs` extension
with the correct `.wbf` in the sentence "See [Custom
Fonts](/features/custom-fonts) for information on loading custom `.wbs` font
files for use with the Scrolling Text effect." so it reads `.wbf`, ensuring the
link and "Scrolling Text" reference remain unchanged.
- Line 39: Fix the typos in the Pixelforge docs copy: change "transparend" to
"transparent", "dirctly" to "directly", and "can not" to "cannot" wherever they
appear in the instructions (notably in the sentence describing the "Dark Pixel
Cutoff" slider and the similar sentence later in the same section). Ensure the
sentence reads: "Use the slider 'Dark Pixel Cutoff' to turn dark pixels
transparent and color them in the selected background color. Images with
transparent pixels like GIF and PNG are supported." and update the other
occurrence(s) to use "directly" and "cannot" as appropriate.
In `@docs/interfaces/espnow.md`:
- Line 19: Update the section headings to Title Case (capitalize major words,
leave short articles/prepositions lowercase) for the headings referenced in this
file (e.g., the "Managing remotes" section and the other headings called out in
the review). Edit the markdown headings (the lines that start with ## or ###) so
each major word is capitalized per the project's title-case guideline and ensure
consistency across the headings on the page.
- Line 15: Replace the inline bold "Note:" callout with a MkDocs Material
admonition block; locate the statement in docs/interfaces/espnow.md and convert
it to an appropriate admonition (e.g., use "!!! warning" or "!!! tip" depending
on severity) so the text becomes an admonition block containing "In order for
ESPNow remotes to work reliably the WiFi has to be on all the time - Disable
WiFi Sleep must be set." to match project documentation style.
- Line 64: Replace the non-descriptive link text "here" in
docs/interfaces/espnow.md with a descriptive phrase that explains what the link
points to (e.g., "examples of remote.json configurations on GitHub" or
"remote.json example configurations"), updating the sentence "There are some
examples on how to do that available here" so the anchor text clearly describes
the target (remote-json examples repository) instead of using "here".
---
Outside diff comments:
In `@docs/features/palettes.md`:
- Around line 97-106: The fenced code block showing the JSON palette is missing
a language hint; update the fenced block around the JSON object (the block
starting with {"palette":[ ... 255, 87,255,65]}) to include a JSON language
identifier (```json) on the opening fence so linters and renderers treat it as
JSON and improve readability.
---
Nitpick comments:
In `@docs/features/custom-fonts.md`:
- Line 22: Replace the inline bold "Note:" callout with a MkDocs Material
admonition by converting the sentence starting "Note: if you want the classic
pre 16.0 fonts..." into an admonition block (e.g., start the block with "!!!
tip" or "!!! info" and put the existing text as the block body), and make the
same change for the other instance referenced around the later occurrence;
ensure you remove the bold markup and keep the original wording and punctuation
intact inside the admonition.
In `@docs/features/pixelforge.md`:
- Line 7: Replace the bold "**Note:**" callout in the pixelforge feature doc
with a MkDocs Material admonition: change the line starting with "**Note:** the
gif image player..." to an "!!! info" (or "!!! warning" if you deem it
cautionary) block and move the sentence text inside that admonition; apply the
same replacement for the second instance referenced (the other occurrence at the
later line) so both notes use MkDocs admonition syntax.
In `@docs/interfaces/espnow.md`:
- Line 62: Update the version string "v16.0" to the consistent format "v0.16.0"
in the line containing "Codes 20–22 were added in v16.0" in
docs/interfaces/espnow.md; search for any other occurrences of "v16.0" in that
document and replace them with "v0.16.0" so the file matches the rest of the
documentation's version formatting.
🪄 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: 2b98e666-e6b6-4c4a-a2fa-e0a21d0496ad
📒 Files selected for processing (8)
docs/features/custom-fonts.mddocs/features/effects.mddocs/features/palettes.mddocs/features/particle-system.mddocs/features/pin-info.mddocs/features/pixel-art-converter.mddocs/features/pixelforge.mddocs/interfaces/espnow.md
✅ Files skipped from review due to trivial changes (3)
- docs/features/pixel-art-converter.md
- docs/features/pin-info.md
- docs/features/effects.md
| --- | ||
|
|
||
| WLED supports loading custom bitmap fonts for use with the **Scrolling Text** effect. Custom fonts are stored on the device filesystem as `.wbf` files and can be created with the Font Factory tool, see below. | ||
| The source code of the tool as well as a collection free-to-use fonts are available [on github](https://github.com/DedeHai/WLED-Tools/tree/main/WLED-FontFactory). |
Contributor
There was a problem hiding this comment.
Correct typos/capitalization in user-facing text.
Please fix small text issues like github → GitHub and extenstion → extension.
Based on learnings: "ensure programming language names and API datatype names use consistent, correct capitalization ... Apply this check across all documentation markdown files under docs/."
Also applies to: 60-60
🤖 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/features/custom-fonts.md` at line 6, Fix user-facing
capitalization/typos in docs: in docs/features/custom-fonts.md update "github"
to "GitHub" in the sentence starting "The source code of the tool..." and
correct any occurrences of "extenstion" to "extension"; then scan all markdown
files under docs/ to normalize capitalization for programming language names
(e.g., "JavaScript", "TypeScript", "Python") and API/data-type names (e.g.,
"JSON", "HTTP", "UUID") so they use their standard, correct capitalization
consistently.
|
|
||
| WLED includes both a **1D Particle System** (for strips) and a **2D Particle System** (for matrices). The code is highly optimized for speed so it can be used with well over a thousand particles at high frame rates. | ||
|
|
||
| Since the animations are based on particle properties with some sprinkled in randomness for a more natural behaviour, all "PS" effects are random and undeterministic in nature: the visuals generated never repeat. If you want two segments with particle effects to look identical, use the "Copy Segment" effect. |
Contributor
There was a problem hiding this comment.
Fix terminology typos that can confuse readers.
Please update wording like undeterministic → non-deterministic and quared-distance → squared-distance.
Also applies to: 26-26
🧰 Tools
🪛 LanguageTool
[grammar] ~9-~9: Use a hyphen to join words.
Context: ... particle properties with some sprinkled in randomness for a more natural behavio...
(QB_NEW_EN_HYPHEN)
🤖 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/features/particle-system.md` at line 9, Replace incorrect terminology in
the particle-system docs: change "undeterministic" to "non-deterministic" in the
sentence describing PS effects and change any occurrences of "quared-distance"
to "squared-distance"; ensure the same fixes are applied at the other occurrence
noted (line 26) so both instances use the correct terms and spelling.
| - Collision on/off | ||
| - Wrap-around edges on/off | ||
|
|
||
| The default slider settings were chosen such that the effect looks nice on many different setups but often can be optimized for a specific situation. A description of what each slider/checkmark does for each effect is described [here](/features/effects). |
Contributor
There was a problem hiding this comment.
Replace non-descriptive link text with explicit wording.
[here](/features/effects) is vague. Use descriptive text (e.g., “effect slider reference”).
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 71-71: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 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/features/particle-system.md` at line 71, Replace the vague link text
"[here](/features/effects)" with a descriptive phrase like "effect slider
reference" in the particle-system.md sentence so the link reads something like
"A description of what each slider/checkmark does for each effect is described
in the effect slider reference." Locate and update the markdown line containing
the link to use the new descriptive link text.
|
|
||
| #### Background removal | ||
|
|
||
| Use the slider "Dark Pixel Cutoff" to turn dark pixels transparent and color them in the selected background color. Images with transparend pixels like GIF and PNG are supported. |
Contributor
There was a problem hiding this comment.
Clean up spelling mistakes in key instructions.
Examples: transparend → transparent, dirctly → directly, can not → cannot.
Also applies to: 48-48
🧰 Tools
🪛 LanguageTool
[grammar] ~39-~39: Ensure spelling is correct
Context: ... selected background color. Images with transparend pixels like GIF and PNG are supported. #### S...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~39-~39: Ensure spelling is correct
Context: ...es with transparend pixels like GIF and PNG are supported. #### Save Once happy w...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 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/features/pixelforge.md` at line 39, Fix the typos in the Pixelforge docs
copy: change "transparend" to "transparent", "dirctly" to "directly", and "can
not" to "cannot" wherever they appear in the instructions (notably in the
sentence describing the "Dark Pixel Cutoff" slider and the similar sentence
later in the same section). Ensure the sentence reads: "Use the slider 'Dark
Pixel Cutoff' to turn dark pixels transparent and color them in the selected
background color. Images with transparent pixels like GIF and PNG are
supported." and update the other occurrence(s) to use "directly" and "cannot" as
appropriate.
softhack007
changed the title
Member
|
Wow, that's a mega-update 😁 (and a good testcase for the new AI writing rules) I'll take a look at the AR parts, and also on the HUB75 Info, and push changes/updates to this branch. Give me time until end of the week - my daytime jobs is quite demanding sometimes. |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
use admonition for important note Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
softhack007
reviewed
May 18, 2026
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
* fix heading style (Title Case preferred) * use MkDocs admonitions instead of freestyle "callouts" * minor markdown fixes * fixing an overlooked "wbs" => wbf * fixing some AI slop
This comment was marked as resolved.
This comment was marked as resolved.
while i am here ...
rabbit's suggestion
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
docs/features/pixelforge.md (1)
40-40:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winCorrect “transparend” typo in image handling instructions.
Please update “transparend” to transparent.
🤖 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/features/pixelforge.md` at line 40, Fix the typo in the docs sentence referencing image handling: change the word "transparend" to "transparent" in the paragraph that mentions the slider "Dark Pixel Cutoff" and supported image types (the sentence that currently reads "Images with transparend pixels like GIF and PNG are supported").docs/features/custom-fonts.md (2)
52-52:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix remaining typo/spacing issues in the workflow section.
There are still reader-facing text errors: missing space in “picker)under” and typo “extenstion” → “extension”.
✏️ Suggested patch
-It is available in the PixelForge (button below the color picker)under "Other Tools". +It is available in PixelForge (button below the color picker) under "Other Tools". @@ -4. Choose which UTF-8 extenstion to include (e.g. Latin, Cyrillic, Greek etc.) - use preview example text to test +4. Choose which UTF-8 extension to include (e.g. Latin, Cyrillic, Greek etc.) - use preview example text to testAlso applies to: 62-62
🤖 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/features/custom-fonts.md` at line 52, Fix two reader-facing typos in the "WLED Font Factory" sentence in docs/features/custom-fonts.md: insert a missing space between "picker)" and "under" so it reads "picker) under", and correct the misspelled word "extenstion" to "extension" wherever it appears in the workflow section (e.g., the sentence mentioning .wbf file extension).
6-6:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winCapitalize “GitHub” in user-facing text.
Please change “github” to GitHub in the external link sentence.
Based on learnings: "ensure programming language names and API datatype names use consistent, correct capitalization ... Apply this check across all documentation markdown files under docs/."
🤖 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/features/custom-fonts.md` at line 6, Replace the lowercase token "github" with the correctly capitalized "GitHub" in the external link sentence (the instance shown as "github" in the diff) and commit that change; then run a quick pass over all markdown files under the docs/ directory to normalize capitalization of programming language and API/datatype names (e.g. change "javascript"→"JavaScript", "python"→"Python", "json"→"JSON", "boolean"→"Boolean", etc.) so naming is consistent across documentation.docs/interfaces/espnow.md (1)
65-65:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse descriptive link text instead of “here.”
At Line 65, the anchor text is non-descriptive. Make the link text explain the destination.
As per coding guidelines: Use simple and clear language with short sentences and common words.📝 Proposed fix
-Additional codes can be used by adding a `remote.json` file. There are some examples on how to do that available [here](https://github.com/DedeHai/WLED-ESPNow-Remote/tree/main/remote-json). +Additional codes can be used by adding a `remote.json` file. [Example `remote.json` files](https://github.com/DedeHai/WLED-ESPNow-Remote/tree/main/remote-json) are available in the ESPNow Remote repository.🤖 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/interfaces/espnow.md` at line 65, Replace the non-descriptive anchor text "here" in the sentence that mentions adding a `remote.json` file with a clear, descriptive label (for example: "WLED-ESPNow-Remote remote-json examples on GitHub" or "examples of remote.json on the WLED-ESPNow-Remote GitHub") so the link text explains its destination while keeping the same URL; update the sentence that currently reads "There are some examples on how to do that available [here](...)" to use the new descriptive link text.
🧹 Nitpick comments (1)
docs/features/pixelforge.md (1)
16-16: ⚡ Quick winSplit this long paragraph into shorter instructions for readability.
This sentence block is dense and harder to scan; splitting it into 2–4 short sentences/bullets would better match the docs style guide for non-native readers.
As per coding guidelines: "Use simple and clear language with short sentences and common words, avoiding unexplained jargon to ensure non-native English speakers can easily follow."
🤖 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/features/pixelforge.md` at line 16, The paragraph that begins "Both the image tool to convert images into gif's and the scrolling text tool are built in tools..." is too dense—split it into 2–4 short sentences or bullets to improve readability and follow the docs style guide; explicitly mention the built-in tools ("image tool" and "scrolling text tool"), the "Other Tools" tab behavior (downloaded tools are stored permanently on the controller unless deleted), and the connectivity requirement (phone/PC needs internet to download, but the WLED controller does not and tools work offline/in AP mode) so each idea is its own short sentence or bullet.
🤖 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/interfaces/infrared.md`:
- Line 18: The heading "### Supported IR Remotes" is using a third-level heading
while it should be a top-level section within the page; change the heading text
to "## Supported IR Remotes" (update the line containing the "Supported IR
Remotes" heading) so the document maintains correct heading hierarchy and avoids
skipping levels.
---
Duplicate comments:
In `@docs/features/custom-fonts.md`:
- Line 52: Fix two reader-facing typos in the "WLED Font Factory" sentence in
docs/features/custom-fonts.md: insert a missing space between "picker)" and
"under" so it reads "picker) under", and correct the misspelled word
"extenstion" to "extension" wherever it appears in the workflow section (e.g.,
the sentence mentioning .wbf file extension).
- Line 6: Replace the lowercase token "github" with the correctly capitalized
"GitHub" in the external link sentence (the instance shown as "github" in the
diff) and commit that change; then run a quick pass over all markdown files
under the docs/ directory to normalize capitalization of programming language
and API/datatype names (e.g. change "javascript"→"JavaScript",
"python"→"Python", "json"→"JSON", "boolean"→"Boolean", etc.) so naming is
consistent across documentation.
In `@docs/features/pixelforge.md`:
- Line 40: Fix the typo in the docs sentence referencing image handling: change
the word "transparend" to "transparent" in the paragraph that mentions the
slider "Dark Pixel Cutoff" and supported image types (the sentence that
currently reads "Images with transparend pixels like GIF and PNG are
supported").
In `@docs/interfaces/espnow.md`:
- Line 65: Replace the non-descriptive anchor text "here" in the sentence that
mentions adding a `remote.json` file with a clear, descriptive label (for
example: "WLED-ESPNow-Remote remote-json examples on GitHub" or "examples of
remote.json on the WLED-ESPNow-Remote GitHub") so the link text explains its
destination while keeping the same URL; update the sentence that currently reads
"There are some examples on how to do that available [here](...)" to use the new
descriptive link text.
---
Nitpick comments:
In `@docs/features/pixelforge.md`:
- Line 16: The paragraph that begins "Both the image tool to convert images into
gif's and the scrolling text tool are built in tools..." is too dense—split it
into 2–4 short sentences or bullets to improve readability and follow the docs
style guide; explicitly mention the built-in tools ("image tool" and "scrolling
text tool"), the "Other Tools" tab behavior (downloaded tools are stored
permanently on the controller unless deleted), and the connectivity requirement
(phone/PC needs internet to download, but the WLED controller does not and tools
work offline/in AP mode) so each idea is its own short sentence or bullet.
🪄 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: 711c2fe2-3d15-47fe-9d52-7b6205094103
📒 Files selected for processing (14)
docs/advanced/HUB75.mddocs/basics/getting-started.mddocs/features/custom-fonts.mddocs/features/macros.mddocs/features/palettes.mddocs/features/pixel-art-converter.mddocs/features/pixelforge.mddocs/interfaces/dmx-input.mddocs/interfaces/dmx-output.mddocs/interfaces/e1.31-dmx.mddocs/interfaces/espnow.mddocs/interfaces/infrared.mddocs/interfaces/json-api.mddocs/interfaces/mqtt.md
✅ Files skipped from review due to trivial changes (5)
- docs/basics/getting-started.md
- docs/interfaces/e1.31-dmx.md
- docs/features/pixel-art-converter.md
- docs/features/macros.md
- docs/features/palettes.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/interfaces/mqtt.md
Member
|
@netmindz HUB75 pages currently list the panel sizes and max pixel counts supported in WLED-MM. We should double-check if WLED has some additional limitations, like 4096 pixels-per-bus or unsupported 128x64 panel size. |
fix heading level Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
softhack007
reviewed
May 18, 2026
| * Maximum possible sizes: see previous section | ||
| * combining HUB75 with other LED types (including virtual leds) was not tested yet - it may or may not work. | ||
| * Maximum possible sizes: [see previous section](#panel-size-and-chain-length) | ||
| * After changing HUB75 options (LED preferences), your display will go black. You need to reboot for driver changes to take effect. |
Member
There was a problem hiding this comment.
not sure if this still applies in upstream WLED, need to test.
Collaborator
|
@softhack007 somehow I got an automatic "merge branch" commit. not sure why that happened, please check that commit did not undo anything. |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
docs/features/pixelforge.md (1)
40-40:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix typo: "transparend" → "transparent".
This spelling error was flagged in a previous review but is still present.
✏️ Proposed fix
-Use the slider "Dark Pixel Cutoff" to turn dark pixels transparent and color them in the selected background color. Images with transparend pixels like GIF and PNG are supported. +Use the slider "Dark Pixel Cutoff" to turn dark pixels transparent and color them in the selected background color. Images with transparent pixels like GIF and PNG are supported.🤖 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/features/pixelforge.md` at line 40, Fix the spelling mistake "transparend" to "transparent" in the docs/features/pixelforge.md sentence that mentions the "Dark Pixel Cutoff" slider (the line that reads "Images with transparend pixels like GIF and PNG are supported"); update that word only so the sentence reads "...Images with transparent pixels like GIF and PNG are supported."
🧹 Nitpick comments (3)
docs/interfaces/infrared.md (3)
30-30: ⚡ Quick winHyphenate compound adjective in heading.
The compound adjective "ESP-NOW Based" modifying "Remote Control" should be hyphenated as "ESP-NOW-Based" per standard English grammar rules.
📝 Proposed fix
-## ESP-NOW Based Remote Control +## ESP-NOW-Based Remote Control🤖 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/interfaces/infrared.md` at line 30, Update the markdown heading text "ESP-NOW Based Remote Control" to use a hyphenated compound adjective: change it to "ESP-NOW-Based Remote Control" so the compound modifier correctly hyphenates the phrase.
28-28: ⚡ Quick winRemove
.mdextension from internal link.The internal link includes the
.mdextension, which should be omitted per documentation guidelines.🔗 Proposed fix
-7. [JSON IR remote](json-ir/json_infrared.md) - Easily configure and use any IR remote. +7. [JSON IR remote](json-ir/json_infrared) - Easily configure and use any IR remote.As per coding guidelines: Use root-relative paths without the
.mdextension for internal links.🤖 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/interfaces/infrared.md` at line 28, Update the internal markdown link target for "JSON IR remote" by removing the .md extension and using a root-relative path per docs guidelines; replace the link target "json-ir/json_infrared.md" with "json-ir/json_infrared" (or the appropriate root-relative variant) so the markdown link text "[JSON IR remote]" points to the extension-less path.
32-32: ⚡ Quick winHyphenate compound adjective and consider version format consistency.
Two minor style improvements:
- "ESP-NOW compatible" should be hyphenated as "ESP-NOW-compatible" when used as a compound adjective before the noun.
- Consider adding the "v" prefix to "0.14.0-beta3" for consistency with version references at line 10 ("v0.8.2", "v0.9.0").
📝 Proposed fix
-Since version WLED 0.14.0-beta3: An ESP-NOW compatible remote control is supported. An example of this is the „WIZmote" remote control. This is based on an ESP microcontroller. You can also [build your own ESP-NOW remote](https://github.com/DedeHai/WLED-ESPNow-Remote) using an ESP32 C3. ESP-NOW can be activated in WLED settings. You have to enter the Hardware MAC address of the remote control. This is determined by clicking on any button on the remote control and copying the last received MAC address from the "Last Seen" field to the "Hardware MAC" field in WLED ESP-NOW settings ("Config->WiFi Setup") and saving it with "Save". Advantages: no special receiver needs to be attached to the WLED controller and the signals are transmitted via radio network. Therefore there is no line of sight between the remote control and the WLED controller required, as is the case with an IR remote control. +Since version WLED v0.14.0-beta3: An ESP-NOW-compatible remote control is supported. An example of this is the „WIZmote" remote control. This is based on an ESP microcontroller. You can also [build your own ESP-NOW remote](https://github.com/DedeHai/WLED-ESPNow-Remote) using an ESP32 C3. ESP-NOW can be activated in WLED settings. You have to enter the Hardware MAC address of the remote control. This is determined by clicking on any button on the remote control and copying the last received MAC address from the "Last Seen" field to the "Hardware MAC" field in WLED ESP-NOW settings ("Config->WiFi Setup") and saving it with "Save". Advantages: no special receiver needs to be attached to the WLED controller and the signals are transmitted via radio network. Therefore there is no line of sight between the remote control and the WLED controller required, as is the case with an IR remote control.🤖 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/interfaces/infrared.md` at line 32, Change the phrasing so the compound adjective is hyphenated and the version uses a consistent "v" prefix: replace "ESP-NOW compatible remote control" with "ESP-NOW-compatible remote control" and change "WLED 0.14.0-beta3" to "WLED v0.14.0-beta3" in the paragraph describing ESP-NOW support (the sentence containing "ESP-NOW compatible" and "WLED 0.14.0-beta3").
🤖 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/features/pixelforge.md`:
- Line 54: The sentence "Animated GIFs are _mostly_ supported..." uses lowercase
"gif" twice; update both occurrences of "gif" in that sentence to uppercase
"GIF" for consistency (i.e., "Animated GIFs are _mostly_ supported..." and
"convert the GIF using the PixelForge tool...") so all instances match the
document's use of "GIF".
- Line 72: In the sentence "If you text is very short, the preview still shows
scrolling but on the actual LEDs it will show as a static, non scrolling text
for example.", fix the two grammar issues by changing "you text" to "your text"
and "non scrolling" to "non‑scrolling" and adjust punctuation by adding a comma
before "for example" (resulting in: "If your text is very short, the preview
still shows scrolling, but on the actual LEDs it will show as a static,
non‑scrolling text, for example.").
- Line 16: The sentence starting "Both the image tool to convert images into
gif's and the scrolling text tool are built in tools..." contains grammar and
verbosity issues; update it to "Both the image tool (which converts images into
GIFs) and the scrolling text tool are built-in tools. In the Other Tools tab you
can download additional tools; these are not included by default but are stored
permanently on your controller unless deleted. To download tools your phone/PC
needs internet access, but the WLED controller does not; once downloaded, tools
work offline and in AP mode." Ensure "built-in" is hyphenated, "GIFs" is
capitalized and not possessive, and replace "In order to be able to download"
with "To download."
---
Duplicate comments:
In `@docs/features/pixelforge.md`:
- Line 40: Fix the spelling mistake "transparend" to "transparent" in the
docs/features/pixelforge.md sentence that mentions the "Dark Pixel Cutoff"
slider (the line that reads "Images with transparend pixels like GIF and PNG are
supported"); update that word only so the sentence reads "...Images with
transparent pixels like GIF and PNG are supported."
---
Nitpick comments:
In `@docs/interfaces/infrared.md`:
- Line 30: Update the markdown heading text "ESP-NOW Based Remote Control" to
use a hyphenated compound adjective: change it to "ESP-NOW-Based Remote Control"
so the compound modifier correctly hyphenates the phrase.
- Line 28: Update the internal markdown link target for "JSON IR remote" by
removing the .md extension and using a root-relative path per docs guidelines;
replace the link target "json-ir/json_infrared.md" with "json-ir/json_infrared"
(or the appropriate root-relative variant) so the markdown link text "[JSON IR
remote]" points to the extension-less path.
- Line 32: Change the phrasing so the compound adjective is hyphenated and the
version uses a consistent "v" prefix: replace "ESP-NOW compatible remote
control" with "ESP-NOW-compatible remote control" and change "WLED 0.14.0-beta3"
to "WLED v0.14.0-beta3" in the paragraph describing ESP-NOW support (the
sentence containing "ESP-NOW compatible" and "WLED 0.14.0-beta3").
🪄 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: fc2f26d4-65a2-4f7e-9e95-0de4fa5d8272
📒 Files selected for processing (2)
docs/features/pixelforge.mddocs/interfaces/infrared.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/features/pixelforge.md (3)
40-40:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix typo:
transparend→transparent(Line 40).Small spelling fix in a key instruction sentence.
🤖 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/features/pixelforge.md` at line 40, Fix the spelling mistake in the user-facing description sentence that currently reads "Images with transparend pixels like GIF and PNG are supported." — replace "transparend" with "transparent" in the string that mentions the "Dark Pixel Cutoff" slider and the supported image formats so the sentence reads "...Images with transparent pixels like GIF and PNG are supported."
72-72:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winHyphenate
non-scrollingin preview limitations (Line 72).Use the compound adjective form for clarity and consistency.
🤖 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/features/pixelforge.md` at line 72, Edit the sentence that currently reads "It will show as a static, non scrolling text" in the Pixelforge preview description (the paragraph beginning "The preview shows only a simulation...") and hyphenate the compound adjective to "non-scrolling" so it reads "...static, non-scrolling text"; ensure the rest of the sentence punctuation and spacing remain unchanged.
16-16:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winPolish wording and grammar in the built-in tools paragraph (Line 16).
This sentence is hard to scan and still includes style issues (
GIF's,built in,In order to be able to,phone/pc). Please split it into shorter sentences and normalize terms (e.g.,GIFs,built-in,phone/PC).🤖 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/features/pixelforge.md` at line 16, Rewrite the paragraph that begins "Both the image tool to convert images into GIF's and the scrolling text tool are built in tools..." to improve grammar and readability: replace "GIF's" with "GIFs", "built in" with "built-in", and "phone/pc" with "phone/PC"; split into two or three shorter sentences so it reads clearly (e.g., state that the image-to-GIF and scrolling text tools are built-in, explain that additional tools can be downloaded from the "Other Tools" tab and are stored permanently on the controller unless deleted, and note that downloads require internet on your phone/PC but the tools work offline thereafter, including in AP mode). Ensure capitalization and hyphenation are normalized throughout.
🤖 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/features/pixelforge.md`:
- Line 64: The sentence in the Pixelforge docs for the "Scrolling Text" tab
contains a duplicated verb phrase ("configure and preview and control"); change
it to a grammatically correct list such as "configure, preview, and control" so
the line reads: The Scrolling Text tab lets you configure, preview, and control
the **Scrolling Text** effect; update the sentence in
docs/features/pixelforge.md where the "Scrolling Text tab" description appears.
---
Duplicate comments:
In `@docs/features/pixelforge.md`:
- Line 40: Fix the spelling mistake in the user-facing description sentence that
currently reads "Images with transparend pixels like GIF and PNG are supported."
— replace "transparend" with "transparent" in the string that mentions the "Dark
Pixel Cutoff" slider and the supported image formats so the sentence reads
"...Images with transparent pixels like GIF and PNG are supported."
- Line 72: Edit the sentence that currently reads "It will show as a static, non
scrolling text" in the Pixelforge preview description (the paragraph beginning
"The preview shows only a simulation...") and hyphenate the compound adjective
to "non-scrolling" so it reads "...static, non-scrolling text"; ensure the rest
of the sentence punctuation and spacing remain unchanged.
- Line 16: Rewrite the paragraph that begins "Both the image tool to convert
images into GIF's and the scrolling text tool are built in tools..." to improve
grammar and readability: replace "GIF's" with "GIFs", "built in" with
"built-in", and "phone/pc" with "phone/PC"; split into two or three shorter
sentences so it reads clearly (e.g., state that the image-to-GIF and scrolling
text tools are built-in, explain that additional tools can be downloaded from
the "Other Tools" tab and are stored permanently on the controller unless
deleted, and note that downloads require internet on your phone/PC but the tools
work offline thereafter, including in AP mode). Ensure capitalization and
hyphenation are normalized throughout.
🪄 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: 32c5689f-2ffc-4255-9c0d-40c0c7d81be5
📒 Files selected for processing (2)
docs/features/pixelforge.mddocs/interfaces/infrared.md
softhack007
reviewed
May 18, 2026
| ## Buttons | ||
|
|
||
| Multiple buttons are implemented since 0.13 and allow a few different types of buttons to be connected to the ESP: | ||
| Multiple buttons are implemented since 0.13. Starting in v16.0, up to **32 buttons** can be configured without any custom compilation — use the LED Settings page to add as many as you need. |
Member
There was a problem hiding this comment.
.... and as many as your board supports ;-) esp32-c3 has 22 but some are not usable for digital I/O.
Member
@DedeHai 🤔 unexpected ... maybe you had some staged commits but git first needed to sync. |
* added some clarifications, caveats and useful hints * link to WLED-MM documentation for additional information
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/interfaces/infrared.md (1)
32-32: ⚡ Quick winConvert inline “Advantages:” to an admonition block.
At Line 32,
Advantages:is a callout in plain text. Please convert it to MkDocs Material admonition syntax for consistency.💡 Proposed change
-Since version WLED 0.14.0-beta3: An ESP-NOW compatible remote control is supported. An example of this is the „WIZmote“ remote control. This is based on an ESP microcontroller. You can also [build your own ESP-NOW remote](https://github.com/DedeHai/WLED-ESPNow-Remote) using an ESP32 C3. ESP-NOW can be activated in WLED settings. You have to enter the Hardware MAC address of the remote control. This is determined by clicking on any button on the remote control and copying the last received MAC address from the "Last Seen" field to the "Hardware MAC" field in WLED ESP-NOW settings (“Config->WiFi Setup”) and saving it with "Save". Advantages: no special receiver needs to be attached to the WLED controller and the signals are transmitted via radio network. Therefore there is no line of sight between the remote control and the WLED controller required, as is the case with an IR remote control. +Since version WLED 0.14.0-beta3: An ESP-NOW compatible remote control is supported. An example of this is the „WIZmote“ remote control. This is based on an ESP microcontroller. You can also [build your own ESP-NOW remote](https://github.com/DedeHai/WLED-ESPNow-Remote) using an ESP32 C3. ESP-NOW can be activated in WLED settings. You have to enter the Hardware MAC address of the remote control. This is determined by clicking on any button on the remote control and copying the last received MAC address from the "Last Seen" field to the "Hardware MAC" field in WLED ESP-NOW settings (“Config->WiFi Setup”) and saving it with "Save". + +!!! tip "Advantages" + No special receiver needs to be attached to the WLED controller, and signals are transmitted over radio. So, unlike IR remotes, line of sight is not required.As per coding guidelines: Use MkDocs Material admonitions (
!!! info,!!! tip,!!! warning,!!! danger) for callouts instead of other formatting methods.🤖 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/interfaces/infrared.md` at line 32, Replace the plain-text "Advantages:" callout in the paragraph that begins with "Since version WLED 0.14.0-beta3..." by converting it to a MkDocs Material admonition: locate the sentence starting with "Advantages:" and change it into an admonition block (e.g. use "!!! info \"Advantages\"" or another appropriate level) and move the following sentence(s) about no special receiver, radio transmission, and no line-of-sight inside that admonition body so the content remains identical but uses MkDocs Material admonition syntax.
🤖 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/audio-reactive.md`:
- Around line 28-31: Replace the non-standard MkDocs admonition "!!! Note" used
around the "Left Channel" callout with one of the allowed Material admonition
types (for example "!!! info" or "!!! tip"); update the opening admonition
marker "!!! Note \"Left Channel\"" to "!!! info \"Left Channel\"" (or another
allowed type) so the callout conforms to the repo's MkDocs Material standards.
- Around line 65-67: Replace the unsupported MkDocs callout marker "!!! failure"
with an allowed admonition type (e.g., "!!! warning" or "!!! danger") in the
admonition block that starts with "!!! failure \"Don't Waste Your Money on
Cheapest Hardware\"" so the repo's MkDocs Material callout set is used; keep the
existing block content unchanged and preserve indentation/blank lines around the
admonition to maintain rendering.
---
Nitpick comments:
In `@docs/interfaces/infrared.md`:
- Line 32: Replace the plain-text "Advantages:" callout in the paragraph that
begins with "Since version WLED 0.14.0-beta3..." by converting it to a MkDocs
Material admonition: locate the sentence starting with "Advantages:" and change
it into an admonition block (e.g. use "!!! info \"Advantages\"" or another
appropriate level) and move the following sentence(s) about no special receiver,
radio transmission, and no line-of-sight inside that admonition body so the
content remains identical but uses MkDocs Material admonition 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: d143aef2-f034-4c3e-bcb2-c31035aa6b94
⛔ Files ignored due to path filters (1)
docs/assets/images/content/example_i2s_mic.jpgis excluded by!**/*.jpg
📒 Files selected for processing (3)
docs/advanced/audio-reactive.mddocs/features/pixelforge.mddocs/interfaces/infrared.md
change heading level Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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
3 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