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, did some cleanup.

Copy link
Contributor

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 build scripts.

Key changes:

  • Replaced mkdocs.yml with zensical.toml configuration
  • Updated dependencies in pyproject.toml and uv.lock to use zensical instead of mkdocs-material
  • Modified build scripts to use zensical commands
  • Added test fixture RTF output files

Reviewed changes

Copilot reviewed 25 out of 63 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 settings, navigation, theme, and plugin configurations
uv.lock Removed mkdocs-material and related dependencies (babel, backrefs, certifi, charset-normalizer, idna, requests, urllib3, mkdocs-material-extensions, paginate); added zensical and deepmerge
pyproject.toml Updated dev dependencies to replace mkdocs and mkdocs-material with zensical>=0.0.15
mkdocs.yml Deleted old mkdocs configuration file
scripts/check_rtf.sh Updated to use zensical build command instead of mkdocs build
docs/scripts/sync.sh Updated comment to reference Zensical instead of mkdocs
tests/fixtures/docs_outputs/*.rtf Added multiple test fixture RTF files for documentation validation

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

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

3 participants