Skip to content

Conversation

@nanxstats
Copy link
Collaborator

This PR migrates the documentation site generator framework from mkdocs-material to zensical.

Also migrated the GitHub Actions workflow.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR migrates the documentation site generator from mkdocs-material to zensical, a newer documentation framework. The migration includes updating configuration files, dependencies, and the GitHub Actions deployment workflow.

Key Changes:

  • Replaced mkdocs.yml with zensical.toml for documentation configuration
  • Removed mkdocs-material and related dependencies, added zensical as the new documentation generator
  • Updated GitHub Actions workflow to use the new zensical build process with GitHub Pages deployment

Reviewed changes

Copilot reviewed 13 out of 17 changed files in this pull request and generated no comments.

Show a summary per file
File Description
zensical.toml New configuration file for zensical documentation framework with project metadata, navigation, theme settings, and plugin configuration
uv.lock Updated dependency lock file removing mkdocs-material related packages and adding zensical and deepmerge dependencies
pyproject.toml Updated development dependencies to replace mkdocs-material with zensical, and updated version constraints for other tools
mkdocs.yml Removed the old mkdocs-material configuration file
.github/workflows/mkdocs.yml Removed the old mkdocs deployment workflow
.github/workflows/docs.yml New GitHub Actions workflow for deploying documentation using zensical with GitHub Pages
docs/stylesheets/extra.css Updated CSS styles with new font configurations and styling for the zensical theme
docs/scripts/sync.sh Updated comment to reference "Zensical site" instead of "mkdocs"
docs/reference/*.md Removed mkdocstrings options that are now centrally configured in zensical.toml
docs/index.md Updated badge reference from "mkdocs" workflow to "Documentation" workflow
README.md Updated badge reference from "mkdocs" workflow to "Documentation" workflow and minor wording adjustments
.gitignore Added entry to ignore the /site/ directory generated by zensical

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nanxstats nanxstats merged commit 15bff4b into main Jan 2, 2026
15 checks passed
@nanxstats nanxstats deleted the zensical branch January 2, 2026 07:21
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.

2 participants