From 706591a5709509a168b5b0f4fb69cf167416a059 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Sun, 26 Jul 2026 10:09:26 -0500 Subject: [PATCH] Replace hand-made "Moved" stub pages with real redirects 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. --- .github/workflows/main.yml | 2 +- AGENTS.md | 2 +- docs/advanced/compile-analog.md | 8 -------- docs/advanced/compile-wled.md | 8 -------- docs/basics/compiling-wled.md | 8 -------- mkdocs.yml | 7 ++++++- 6 files changed, 8 insertions(+), 27 deletions(-) delete mode 100644 docs/advanced/compile-analog.md delete mode 100644 docs/advanced/compile-wled.md delete mode 100644 docs/basics/compiling-wled.md diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1039891db..543db6e88 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -22,7 +22,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install mkdocs-material + pip install mkdocs-material mkdocs-redirects - name: Deploy run: mkdocs gh-deploy --force diff --git a/AGENTS.md b/AGENTS.md index f2ead7430..a8e63eca5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -145,7 +145,7 @@ docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material **Python/pip:** ```bash -pip install mkdocs-material +pip install mkdocs-material mkdocs-redirects mkdocs serve ``` diff --git a/docs/advanced/compile-analog.md b/docs/advanced/compile-analog.md deleted file mode 100644 index 6c4e25216..000000000 --- a/docs/advanced/compile-analog.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Compile Analog WLED -hide: - # - navigation - # - toc ---- - -Moved, see [How to compile WLED](/advanced/compiling-wled.md) diff --git a/docs/advanced/compile-wled.md b/docs/advanced/compile-wled.md deleted file mode 100644 index b8f25baef..000000000 --- a/docs/advanced/compile-wled.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Compile WLED -hide: - # - navigation - # - toc ---- - -Moved, see [How to compile WLED](/advanced/compiling-wled) \ No newline at end of file diff --git a/docs/basics/compiling-wled.md b/docs/basics/compiling-wled.md deleted file mode 100644 index 1846a3fc1..000000000 --- a/docs/basics/compiling-wled.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Compiling WLED -hide: - # - navigation - # - toc ---- - -Moved, see [How to compile WLED](/advanced/compiling-wled) diff --git a/mkdocs.yml b/mkdocs.yml index 0aab9ffd4..ed9055036 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,8 +33,13 @@ theme: toggle: icon: material/weather-night name: Dark Mode -plugins: +plugins: - search + - redirects: + redirect_maps: + advanced/compile-analog.md: advanced/compiling-wled.md + advanced/compile-wled.md: advanced/compiling-wled.md + basics/compiling-wled.md: advanced/compiling-wled.md markdown_extensions: - admonition - attr_list