Skip to content

Replace MkDocs/Material with Zensical - #83

Draft
forman wants to merge 5 commits into
mainfrom
forman/81-use_zensical
Draft

forman wants to merge 5 commits into
mainfrom
forman/81-use_zensical

Conversation

@forman

@forman forman commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Migrate documentation to zensical.toml using the classic theme. Preserve navigation, search, light/dark mode, icons, Python API references, legal footer links, and self-hosted fonts.

Move documentation helpers into docs/scripts/. Keep the existing Pixi build and preview commands, with automatic rule-reference regeneration during preview. Add dated migration notes covering dependency versions, compatibility differences, and remaining workarounds. MkDocs remains a transitive dependency of the API renderer.

Also added .github/CODEOWNERS.

Validation:

  • Clean strict documentation build passes without issues.
  • Live preview updates after rule-description edits and restoration.
  • Generated pages, API links, icons, fonts, footer, and search assets verified.
  • Three focused tests, repository lint, and formatting checks pass.

Checklist (strike out non-applicable):

  • Changes documented in CHANGES.md
  • Related issue exists and is referred to in the PR description and CHANGES.md
  • Added docstrings and API docs for any new/modified user-facing classes and functions
  • Changes/features documented in docs/*
  • Unit-tests adapted/added for changes/features
  • Test coverage remains or increases (target 100%)

…oml) with the classic theme. Preserved basic functionality, including fonts, API docs, legal footer, and rule-reference regeneration during preview. Added CODEOWNERS.
@codecov

codecov Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.42%. Comparing base (44ff94d) to head (3504736).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #83   +/-   ##
=======================================
  Coverage   99.42%   99.42%           
=======================================
  Files          75       75           
  Lines        2975     2975           
  Branches      432      432           
=======================================
  Hits         2958     2958           
  Misses          1        1           
  Partials       16       16           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@forman
forman requested a review from clarasb November 20, 2026 06:58

This branch has not been deployed

No deployments
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.

Replace MkDocs by Zensical

1 participant