Skip to content

Migrate docs from mkdocs to zensical#14

Merged
wckdouglas merged 2 commits intomainfrom
migrate-doc
Mar 16, 2026
Merged

Migrate docs from mkdocs to zensical#14
wckdouglas merged 2 commits intomainfrom
migrate-doc

Conversation

@wckdouglas
Copy link
Copy Markdown
Owner

Summary

  • Replace mkdocs-material with zensical for documentation generation
  • Move dev dependencies from [tool.rye] to [dependency-groups] (PEP 735, native uv support)
  • Use modern GitHub Actions Pages deployment (upload-pages-artifact + deploy-pages) instead of mkdocs gh-deploy
  • Delete rye lock files (requirements.lock, requirements-dev.lock) — uv.lock is authoritative

Notes

  • mkdocs.yml and docs/*.md are unchanged — zensical reads them natively
  • Zensical requires Python >= 3.10; CI deploy job uses python: 3.x (latest)
  • Action required: Enable "GitHub Actions" as the Pages source in repo Settings > Pages > Source

Test plan

  • uv run zensical build --clean succeeds — all 5 pages render
  • All 25 tests pass with 100% coverage
  • Verify GitHub Pages deployment after merge

🤖 Generated with Claude Code

wckdouglas and others added 2 commits March 16, 2026 14:22
- Replace mkdocs-material with zensical in dev deps and CI
- Move dev-dependencies from [tool.rye] to [dependency-groups] (PEP 735)
- Use GitHub Actions Pages deployment (upload-pages-artifact + deploy-pages)
  instead of mkdocs gh-deploy
- Delete rye lock files (uv.lock is authoritative)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Replace rye with uv in build, publish, and deploy jobs
- Use astral-sh/setup-uv@v5 action
- Run checks inline with uv run instead of rye run

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

Coverage report

This PR does not seem to contain any modification to coverable code.

@wckdouglas wckdouglas merged commit 540e524 into main Mar 16, 2026
5 checks passed
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