-
Notifications
You must be signed in to change notification settings - Fork 0
Migrate docs build from MkDocs to Zensical #329
Copy link
Copy link
Labels
type:choreMaintenance, cleanup, dependency updatesMaintenance, cleanup, dependency updates
Description
Context
MkDocs has been unmaintained since August 2024. Material for MkDocs (v9.7.5) entered maintenance mode — 12 months of critical fixes only, no new features. Zensical is the designated successor, built by the same team (squidfunk), MIT licensed, reads mkdocs.yml natively, and is designed as a drop-in replacement.
Changes
- Replace
mkdocs-material==9.7.5withzensical==0.0.26inpyproject.toml - Update CI workflows (
pages.yml,pages-preview.yml) to usezensical build - Remove
--strictflag until zensical/backlog#72 ships - Update all documentation references (CLAUDE.md, README.md, decisions.md, scripts, configs)
- No changes to
mkdocs.yml— Zensical reads it natively - mkdocstrings + griffe-pydantic remain unchanged (separate plugin ecosystem)
Not in scope
- No
zensical.tomlcreation (team recommends against it for existing projects) - No
mkdocs.ymlrename or restructure - No content/markdown changes
- No theme changes (same Material design, built-in)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
type:choreMaintenance, cleanup, dependency updatesMaintenance, cleanup, dependency updates