Skip to content

Remove duplicate Compiling WLED nav entry - #351

Open
bharvey88 wants to merge 2 commits into
wled:mainfrom
bharvey88:fix/nav-dedupe
Open

Remove duplicate Compiling WLED nav entry#351
bharvey88 wants to merge 2 commits into
wled:mainfrom
bharvey88:fix/nav-dedupe

Conversation

@bharvey88

@bharvey88 bharvey88 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

The page is listed under both Basics > Installation and Advanced, which renders it twice in the sidebar and confuses the active-page highlight and the prev/next footer links. This keeps the Advanced entry, matching the page's advanced/ folder and URL. If the Basics > Installation slot is the preferred home instead, happy to flip it.

Summary by CodeRabbit

  • Documentation
    • Updated the documentation navigation to remove the duplicate “Compiling WLED” entry from the Installation section.
    • Kept “Compiling WLED” available under Advanced.

The page was listed under both Basics > Installation and Advanced,
which renders it twice in the sidebar and confuses the active-page
highlight and prev/next footer links. Keep the Advanced entry,
matching the page's advanced/ folder and URL. (Easy to flip if the
Basics slot is preferred.)
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 2186699b-390d-4325-b7e0-0c0cb3f88348

📥 Commits

Reviewing files that changed from the base of the PR and between d21ae7b and 83e7803.

📒 Files selected for processing (1)
  • mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • mkdocs.yml

Walkthrough

The MkDocs navigation removes “Compiling WLED” from Installation while preserving its entry under Advanced.

Changes

Documentation navigation update

Layer / File(s) Summary
Installation navigation entry removal
mkdocs.yml
Removes the “Compiling WLED” link from the Installation subsection while leaving the remaining installation links and Advanced entry unchanged.

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

Possibly related PRs

  • wled/WLED-Docs#356: Updates the same Installation navigation by adding the WLED ESP Flasher entry.

Poem

A bunny hops through docs so bright,
“Compiling” moves to Advanced’s light.
Installation paths now neatly flow,
Binary and ESP GUI in tow.
One tiny tweak—then off I go!

🚥 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 accurately describes the main change: removing the duplicate Compiling WLED navigation entry.
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.

@softhack007

softhack007 commented Jul 27, 2026

Copy link
Copy Markdown
Member

@bharvey88 I'd actually prefer to keep the "compiling WLED" page accessible from both "Basics > Installation" and "Advanced" - Fine for me to have two nav entries point to the same page.

Reason:

  • "Basics > Installation > Compiling WLED" has many in-links from external sites, plus its better to have it visible to beginners
  • imho "Advanced > Compiling WLED" is lower priority; it could be removed or stay as a nav reference

Edit: what would be best

  • keep the page URL for "compiling WLED" as it is now
  • keep the "shadow" nav entry under "Basics > Installation" for better visibility of the page

Not sure if mkDocs has a better way to achieve this ?

@softhack007

softhack007 commented Jul 27, 2026

Copy link
Copy Markdown
Member

@bharvey88 it you have the time, maybe try to integrate the suggestions from #161 into the "compiling WLED" page.
It has been on my toDo list for years, always postponed because the VSCode UI screenshots are not 100% up-to-date.

Would be a really nice improvement if people understood that pio run -e esp32dev (or default_envs trickery) is not the only way to compile WLED.

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.

2 participants