Skip to content

Fix runaway code fence on the Compiling WLED page#344

Open
bharvey88 wants to merge 2 commits into
wled:mainfrom
bharvey88:fix/compiling-fence
Open

Fix runaway code fence on the Compiling WLED page#344
bharvey88 wants to merge 2 commits into
wled:mainfrom
bharvey88:fix/compiling-fence

Conversation

@bharvey88

@bharvey88 bharvey88 commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

The "WLED BUILDS" code fence in step 3 of Making a custom environment opens at column 0 while the list around it is indented one space, so the closing fence never matches. Everything after it (steps 4 to 8 and the Adding usermods example) currently renders inside one big code block on the live page.

This indents the fence to the list's content level, so it stays a small snippet inside step 3 and the rest of the section renders normally again. Verified with a local mkdocs build.

Summary by CodeRabbit

  • Documentation
    • Improved formatting of the custom environment compilation instructions.
    • Clearly separated the “WLED BUILDS” marker text in a code block for easier copying and readability.

The "WLED BUILDS" fence in step 3 of Making a custom environment
opens at column 0 while the surrounding list is indented, so the
closing fence never matches. Everything after it (steps 4 to 8 and
the Adding usermods example) renders inside one big code block.
Indent the fence to the list's content level so it stays a small
snippet inside step 3.
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@bharvey88, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 53 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 75cee159-8602-4347-87f5-9783df78eb15

📥 Commits

Reviewing files that changed from the base of the PR and between 96bfa27 and 358245f.

📒 Files selected for processing (1)
  • docs/advanced/compiling-wled.md

Walkthrough

Changes

Documentation formatting

Layer / File(s) Summary
Fence the WLED BUILDS marker
docs/advanced/compiling-wled.md
The platformio.ini guidance wraps the WLED BUILDS comment block in a fenced code block.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: netmindz

Poem

A bunny hops through code,
Backticks fence the build-road,
Comments neatly stay,
In their marked-up array—
Documentation blooms! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: fixing a runaway code fence on the Compiling WLED page.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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/compiling-wled.md`:
- Around line 67-71: Update the fenced code block surrounding the WLED BUILDS
platformio.ini content to specify the ini language identifier, while preserving
the block contents unchanged.
🪄 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 Plus

Run ID: e7c903cc-b763-4522-95d7-4a417b2eac0e

📥 Commits

Reviewing files that changed from the base of the PR and between 1583203 and 96bfa27.

📒 Files selected for processing (1)
  • docs/advanced/compiling-wled.md

Comment thread docs/advanced/compiling-wled.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant