Skip to content

Migrate docs to Zensical - #133

Merged
amrabed merged 3 commits into
mainfrom
feat/replace-mkdocs-with-zensical
Oct 29, 2026
Merged

amrabed merged 3 commits into
mainfrom
feat/replace-mkdocs-with-zensical

Conversation

@amrabed

@amrabed amrabed commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

This PR replaces Material for MkDocs with Zensical, the modern static site generator built by the creators of Material for MkDocs (matching cur8d/python#164), and updates all project dependencies across Python and Node ecosystems to their latest compatible versions.

Key Changes

• Configuration: Replaced mkdocs.yml with native zensical.toml configuration, preserving navigation, theme features, light/dark palettes, and mkdocstrings Python handler options.
• Dependencies:
• Replaced mkdocs and mkdocs-material with zensical and mkdocstrings[python].
• Upgraded all Python dependencies via uv lock --upgrade:
- aws-cdk-lib: 2.274.0 → 2.275.0
- aws-lambda-powertools: 3.37.0 → 3.38.0
- boto3: 1.43.118 → 1.43.122
- botocore: 1.43.118 → 1.43.122
- hypothesis: 6.170.9 → 6.170.13
- moto: 5.2.4 → 5.2.5
- msgpack: 1.2.3 → 1.2.4
- nodeenv: 1.11.0 → 1.11.1
- platformdirs: 4.13.5 → 4.14.0
- pydantic: 2.14.1 → 2.14.2
- pydantic-core: 2.50.1 → 2.50.2
- pydantic-settings: 2.16.1 → 2.16.2
- pytest: 9.1.1 → 9.2.0
- python-discovery: 1.6.4 → 1.6.7
- ruff: 0.17.2 → 0.17.3
- virtualenv: 21.14.13 → 21.15.1
• Upgraded Node / pnpm dependencies via pnpm update:
- aws-cdk-local: 3.0.4 → 3.1.0
- prettier: 3.9.9 → 3.9.10
• Workflow Automation: Updated mise.toml tasks:
• mise run docs:build: runs zensical build --clean
• mise run docs:serve: runs zensical serve
• CI/CD: Updated .github/workflows/docs.yml to build via mise run docs:build and deploy to GitHub Pages using actions/upload-pages-artifact@v5 and actions/deploy-pages@v5.
• Project Templates & Scripts:
• Updated scripts/init.py to target zensical.toml when customizing the template repository.
• Updated scripts/new.py to update zensical.toml when scaffolding new Lambda templates.
• Updated infra/code.py to exclude zensical.toml from Lambda bundle assets.
• Documentation & Skills: Updated references in README.md, docs/README.md, docs/CONTRIBUTING.md, AGENTS.md, .agents/skills/init-project/SKILL.md, .vibe/specs/deploy-localstack/design.md, and .gitignore (added .cache/).

Verification

• mise run lint: passed cleanly
• mise run test: 95/95 tests passed with 100% coverage
• mise run docs:build: built site cleanly with no issues
• mise run infra:synth: synthesized CDK stacks cleanly

@amrabed
amrabed marked this pull request as ready for review October 29, 2026 22:56
@amrabed
amrabed merged commit 50a7da1 into main Oct 29, 2026
3 checks passed
@amrabed
amrabed deleted the feat/replace-mkdocs-with-zensical branch October 29, 2026 23:01
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