Skip to content

Reworked the WLED ESP Flasher page and added mkdocs content tab support - #356

Merged
softhack007 merged 2 commits into
wled:mainfrom
bharvey88:feat/flasher-page
Jul 27, 2026
Merged

Reworked the WLED ESP Flasher page and added mkdocs content tab support#356
softhack007 merged 2 commits into
wled:mainfrom
bharvey88:feat/flasher-page

Conversation

@bharvey88

@bharvey88 bharvey88 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

The WLED ESP Flasher page was orphaned: absent from the nav, and its front-matter title duplicated the ESP GUI page ("Installation using ESP GUI") even though it documents a different tool (the flasher from the WLED-wemos-shield project). The Install Binary page actively recommends it for ESP32, so it deserves a sidebar entry.

  • Retitle to "Install using WLED ESP Flasher" and register it under Basics > Installation, resolving the title collision.
  • Replace the browse-the-GitHub-folder download step with Windows/macOS content tabs that link the zips directly (both verified working).
  • Enable pymdownx.tabbed (alternate style), Material's content tabs. This is the first page to use them; other OS- or board-split pages like Install Binary could adopt them later.

Demo:

install-wled-flasher-content-tabs-example

Update: added a slugify function to the tabbed config so tab anchors derive from the labels (#windows / #macos) instead of the auto-generated #__tabbed_1_1 ids, which makes shared links to a specific tab readable and stable.

Summary by CodeRabbit

  • Documentation
    • Updated installation guidance with clearer, step-by-step instructions for downloading and launching WLED ESP Flasher on Windows and macOS.
    • Renamed the installation page to “Install using WLED ESP Flasher.”
    • Added the installation guide to the documentation navigation.
    • Enabled tabbed content formatting for improved documentation usability.

The page was orphaned: absent from the nav, and its front matter
title duplicated the ESP GUI page ("Installation using ESP GUI"),
even though it documents a different tool (the WLED ESP Flasher
from the WLED-wemos-shield project). Install Binary actively
recommends it for ESP32, so it deserves a sidebar entry.

- retitle to "Install using WLED ESP Flasher" and register it
  under Basics > Installation
- replace the browse-the-GitHub-folder download step with
  Windows/macOS content tabs linking the zips directly (both
  verified: 15MB and 32MB application/zip responses)
- enable pymdownx.tabbed (alternate style), Material's content
  tabs; this is the first page to use them
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The installation documentation now uses the WLED ESP Flasher title, provides platform-specific download instructions, enables tabbed Markdown support, and adds the page to the installation navigation.

Changes

WLED ESP Flasher documentation

Layer / File(s) Summary
Markdown support and navigation
mkdocs.yml
MkDocs enables pymdownx.tabbed with alternate styling and lowercase slugification, and adds the WLED ESP Flasher page under Installation.
WLED ESP Flasher installation guide
docs/basics/install-wled-flasher.md
The page title and download step now identify WLED ESP Flasher and provide Windows and macOS download, unzip, and startup instructions.

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

Possibly related PRs

Suggested reviewers: netmindz

Poem

I’m a rabbit with a flasher to share,
Tabs bloom softly in docs everywhere.
Windows hops, macOS too,
Clear steps guide the firmware through.
WLED shines bright—hip-hop, hooray!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the two main changes: the WLED ESP Flasher docs page rework and the MkDocs tab support update.
✨ 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 merged commit a0c939e into wled:main Jul 27, 2026
1 check passed
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