Conversation
Contributor
There was a problem hiding this comment.
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
approved these changes
Jan 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR migrates the documentation site generator framework from mkdocs-material to zensical.
Also migrated the GitHub Actions workflow, did some cleanup.