Skip to content

Bump zensical to 0.0.58 and declare the redirects plugin - #300

Merged
Naruto merged 1 commit into
developfrom
docs/bump-zensical-and-wire-redirects
Sep 3, 2026
Merged

Bump zensical to 0.0.58 and declare the redirects plugin#300
Naruto merged 1 commit into
developfrom
docs/bump-zensical-and-wire-redirects

Conversation

@Naruto

@Naruto Naruto commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Zensical 0.0.58 rebuilds the build pipeline on a new scheduler, migrates the search, mkdocstrings and autorefs replacements onto it, and adds six more MkDocs plugin replacements (meta, redirects, minify, tags, literate-nav, awesome-nav). That is a large enough change under the hood that the version was checked by building both locales and diffing, not by reading the release notes.

Same change as cri-middleware/SpriteStudio-Docs#51, going into every repo that shares this pin.

Verified

Built en and ja with 0.0.56 and again with 0.0.58, and compared:

  • 19 pages per locale, byte-identical apart from <meta name="generator"> and the theme asset hashes.
  • search.json and ja/search.json byte-identical. The Japanese index is segmented into words rather than indexed as unbroken runs, and the search replacement is exactly what 0.0.58 moved onto the new architecture — so this was the thing most at risk.
  • sitemap.xml and ja/sitemap.xml byte-identical.
  • Both builds --strict, "No issues found", no new warnings.
  • Dependency set unchanged; only zensical itself moves.
  • Zensical's own base.html differs only in six asset hashes, so the overrides/ templates are unaffected. page.is_homepage is still never set, so that workaround is still needed.

The one breaking change in 0.0.58 is dropped wheels — manylinux i686, musllinux i686, musllinux armv7 and win32. CI is ubuntu-latest and local work is macOS, so neither is affected; a 32-bit Windows Python would now fall back to the sdist and demand a Rust toolchain.

What changed

  • docs/requirements.txt — the pin.
  • mkdocs.base.yml — declares redirects. It goes in the base config for two reasons: the plugins: sequence stays defined in exactly one of the three files, and one entry there emits stubs into both site/ and site/ja/, each pointing at its own locale's target. Verified with a throwaway entry before settling on the empty form.

Why there is no redirect map

Nothing has been published from this repo, so there is no live URL to preserve — the map would only point away from URLs nobody ever had. This wires the mechanism, not any particular redirect: the first page that moves after release gets a redirect_maps: entry and keeps its old URL working, anchors included.

0.0.58 rebuilds the plugin pipeline on a new scheduler and moves the `search`
replacement onto it, so the bump was checked by building rather than by reading
the changelog: both locales build `--strict` clean, and all 19 pages per
locale plus both search indexes -- including the segmented Japanese one -- come
out byte-identical to 0.0.56. Only the theme assets change, and there only their
hashes.

`redirects` is one of the six MkDocs plugins 0.0.58 reimplements natively, so it
needs no pin of its own. Nothing has shipped from this site yet, so there is
nothing to redirect; the plugin is declared now so the first page to move after
release has an obvious place to go, keeping its old URL working, anchors
included. One entry in `mkdocs.base.yml` covers both locales.
@Naruto
Naruto merged commit e41a626 into develop Sep 3, 2026
0 of 2 checks passed
@Naruto
Naruto deleted the docs/bump-zensical-and-wire-redirects branch September 3, 2026 01:04
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