Skip to content

Replace hand-made Moved stub pages with real redirects - #352

Merged
softhack007 merged 1 commit into
wled:mainfrom
bharvey88:feat/redirects
Jul 27, 2026
Merged

Replace hand-made Moved stub pages with real redirects#352
softhack007 merged 1 commit into
wled:mainfrom
bharvey88:feat/redirects

Conversation

@bharvey88

@bharvey88 bharvey88 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Three pages contain only a "Moved, see..." line that readers have to click through manually: advanced/compile-analog, advanced/compile-wled, and basics/compiling-wled. This replaces them with the mkdocs-redirects plugin: the old URLs now serve an instant redirect with a canonical link to Compiling WLED, so old bookmarks and inbound links keep working and search engines index the right page.

The plugin is added to the deploy workflow and to the AGENTS.md pip preview instructions. The Docker preview path needs no change: the squidfunk/mkdocs-material image already bundles mkdocs-redirects via the mkdocs-material[recommended] extra.

Summary by CodeRabbit

  • Documentation

    • Consolidated compiling documentation under a single updated page.
    • Added redirects from older compilation documentation links so existing bookmarks continue to work.
    • Removed outdated placeholder pages that pointed to relocated content.
  • Bug Fixes

    • Documentation builds and local previews now support redirect handling, ensuring moved pages resolve correctly.

Three pages contained only a "Moved, see..." line that readers had
to click through manually (advanced/compile-analog, advanced/
compile-wled, basics/compiling-wled). Use the mkdocs-redirects
plugin instead: the old URLs now serve an instant meta-refresh
redirect with a canonical link to advanced/compiling-wled, so
bookmarks and inbound links keep working and search engines get
the right signal.

The plugin is added to the deploy workflow and the AGENTS.md pip
preview instructions. The Docker preview path needs no change: the
squidfunk/mkdocs-material image already bundles mkdocs-redirects
through the mkdocs-material[recommended] extra.
@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: 436e3858-e109-43ce-9688-60744d7a9223

📥 Commits

Reviewing files that changed from the base of the PR and between d792b06 and 706591a.

📒 Files selected for processing (6)
  • .github/workflows/main.yml
  • AGENTS.md
  • docs/advanced/compile-analog.md
  • docs/advanced/compile-wled.md
  • docs/basics/compiling-wled.md
  • mkdocs.yml
💤 Files with no reviewable changes (3)
  • docs/basics/compiling-wled.md
  • docs/advanced/compile-wled.md
  • docs/advanced/compile-analog.md

Walkthrough

MkDocs now installs and enables the redirects plugin, maps legacy compilation pages to advanced/compiling-wled.md, and removes the obsolete page stubs. Local preview instructions match the deployment dependency setup.

Changes

Documentation redirect migration

Layer / File(s) Summary
Configure compilation-page redirects
mkdocs.yml, docs/advanced/compile-analog.md, docs/advanced/compile-wled.md, docs/basics/compiling-wled.md
The redirects plugin maps removed compilation-page paths to advanced/compiling-wled.md.
Install redirect tooling
.github/workflows/main.yml, AGENTS.md
Deployment and local preview installation commands include mkdocs-redirects alongside mkdocs-material.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: copilot

Poem

A bunny hops through docs anew,
Old paths point where pages grew.
Redirects bloom in YAML bright,
Builds and previews now align right.
“Thump!” says the rabbit—“links take flight!”

🚥 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 summarizes the main change: replacing manual moved stub pages with MkDocs redirects.
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.

@bharvey88 bharvey88 mentioned this pull request Jul 26, 2026
@softhack007
softhack007 merged commit b1d26f6 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