Skip to content

Replace the redirect stubs with Zensical's redirects plugin - #270

Merged
seebi merged 1 commit into
mainfrom
feature/zensical-native-redirects
Sep 14, 2026
Merged

seebi merged 1 commit into
mainfrom
feature/zensical-native-redirects

Conversation

@rpietzsch

@rpietzsch rpietzsch commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Merge after the Zensical 0.0.62 bump (feature/zensical-0-0-62). GitHub retargets this PR to main once that branch is deleted.

Zensical implements the redirects plugin since 0.0.61, so the 24 hand-written index.html stubs are replaced by redirect_maps in mkdocs.yml.

  • the build now fails on a redirect target that does not exist
  • links to a section keep their #fragment; the stubs dropped it
  • check_zensical_output reads the redirects from mkdocs.yml and checks that each redirect page lands on its target, which guards against a regression in Zensical's redirect output
  • the redirect conventions and the README are updated

The built site is identical to the stub build apart from the 24 redirect pages (same paths), redirect.json and a config key. task check passes, 59 unit tests pass, and a deliberately broken build fails the redirect check.

Zensical implements the redirects plugin since 0.0.61, so the 24
hand-written index.html stubs are replaced by redirect_maps in
mkdocs.yml. The build now fails on a missing target, and links to a
section keep their #fragment instead of landing at the top of the page.

- read the redirects from mkdocs.yml in check_zensical_output and
  verify that each redirect page lands on its target
- add unit tests for the redirect check
- update the redirect conventions and the README
@rpietzsch
rpietzsch requested a review from seebi September 14, 2026 09:27
@github-actions

Copy link
Copy Markdown

Test Results

0 tests  ±0   0 ✅ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
1 files   ±0   0 ❌ ±0 

Results for commit d7a8a93. ± Comparison against base commit 8916a16.

Base automatically changed from feature/zensical-0-0-62 to main September 14, 2026 11:09
@seebi
seebi merged commit c353887 into main Sep 14, 2026
3 checks passed
@seebi
seebi deleted the feature/zensical-native-redirects branch September 14, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants