Skip to content

Bump zensical to 0.0.60 - #306

Merged
Naruto merged 1 commit into
developfrom
docs/bump-zensical-to-0-0-60
Sep 10, 2026
Merged

Bump zensical to 0.0.60#306
Naruto merged 1 commit into
developfrom
docs/bump-zensical-to-0-0-60

Conversation

@Naruto

@Naruto Naruto commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Zensical 0.0.59 fixed navigation title precedence (zensical/zensical#906); 0.0.60 updates the bundled UI to 0.0.28, adds table-reader support and fixes template inclusion on Windows extended-length paths. Only the first of those reaches this site — and it reaches almost every page, so the version was checked by building both locales and diffing, not by reading the release notes.

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

What the title fix changes

A page's title now comes from its nav label and falls back to the H1. That is what MkDocs and Material have always done; 0.0.58 preferred the H1, which is the bug #906 fixed. Nothing under docs/ sets a title: in front matter, so every page here takes the label written in mkdocs.yml / mkdocs.ja.yml:

page 0.0.58 0.0.60
setup/install 📥 Installation Installation
workflow/usage_scripting 📝 Scripting and Event-Driven Control Scripting & Events
workflow/animation_player 🎞️ Integration with AnimationPlayer (Cinematics and State Machines) AnimationPlayer Integration

Four slots move with the title — <title>, og:title, twitter:title, and the header topic that appears on scroll — plus the path breadcrumb in the search index. The nav itself, the H1, the body, the heading anchors and the URLs are untouched.

Verified

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

  • 19 pages per locale. 16 (en) and 17 (ja) differ, and only in the four title slots.
  • The home page differs only in its header topic, which now reads the nav label instead of the H1.
  • 1 more page differs only in the header topic, where a label containing & is now written as a bare & instead of &amp;. That is Zensical's own escaping of the title it renders; it displays identically, and no label here contains < or anything an HTML parser would read as an entity.
  • search.json and ja/search.json: 160 items on both sides, same location, same text, same segmentation config. Only the path breadcrumb follows the new title. The Japanese index is the fragile one — it is segmented into words — and it is intact.
  • sitemap.xml, ja/sitemap.xml and objects.inv byte-identical.
  • Both locales still build --strict, no new warnings.
  • No <title> collisions: 19 distinct titles per locale, before and after.
  • Wheels, dependencies and requires-python unchanged from 0.0.58. The 32-bit wheels 0.0.58 dropped have not come back, which stays irrelevant on ubuntu-latest and macOS.

CI cannot confirm any of this: Actions runs in this org still fail before the job starts, so the local build is the only gate — as it was for 0.0.58.

What changed

  • docs/requirements.txt — the pin, now the whole file. The header comments were about the migration off MkDocs + Material and about the plugins that replaced mkdocs-static-i18n and mkdocs-callouts, which is finished history. The one live rule in them — a bump here is a bump in every repo that shares this pin — lives in SpriteStudio-Docs' AGENTS.md under "Pinned toolchain", which also names the repos.

Why bump when the output moves

Because the move is Zensical catching up with MkDocs, not drifting from it, and because the pin is worth keeping current until Zensical grows native mkdocs-static-i18n support (zensical/backlog#1) — the one release that would let these repos build both locales from a single config instead of two. Nothing has shipped from these sites that a changed <title> would invalidate.

0.0.59 fixed navigation title precedence (zensical/zensical#906): a page's
title now comes from its nav label and falls back to the H1, the way MkDocs
and Material have always done it. Nothing here sets a title in front matter,
so every page takes the label written in mkdocs.yml / mkdocs.ja.yml, and the
four slots that render a title move with it -- <title>, og:title,
twitter:title and the header topic that appears on scroll -- along with the
path breadcrumb in the search index. The nav itself, the headings, the body,
the anchors and the URLs do not move.

Checked by building both locales with 0.0.58 and again with 0.0.60 and
comparing, rather than by reading the release notes: 19 pages per locale
with 16 of them differing in those four slots, and the home page in its
header topic alone; search.json and ja/search.json keeping their 160 items,
locations, text and segmentation config, with only the path breadcrumb
following the new title; sitemap.xml, ja/sitemap.xml and objects.inv
identical byte for byte; both locales still building --strict with no new
warnings. Wheels, dependencies and requires-python are unchanged from
0.0.58.

The header comments in docs/requirements.txt went with the bump. What they
described -- the migration off MkDocs + Material, and the plugins that
replaced mkdocs-static-i18n and mkdocs-callouts -- is finished history, and
the one live rule in them, that a bump here is a bump in every repo sharing
this pin, is in SpriteStudio-Docs' AGENTS.md under "Pinned toolchain".
@Naruto
Naruto merged commit 6bc0142 into develop Sep 10, 2026
0 of 2 checks passed
@Naruto
Naruto deleted the docs/bump-zensical-to-0-0-60 branch September 10, 2026 23:56
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