Repository navigation
Build the docs with Zensical instead of mkdocs-material - #62
Merged
Merged
Conversation
Zensical reads mkdocs.yaml unchanged and uses the classic theme variant to keep the look. It has no gh-deploy, so the docs workflow deploys with the GitHub Pages actions. The git-committers plugin is dropped. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Reviewer's GuideThe PR migrates documentation builds from MkDocs Material to Zensical using the existing mkdocs.yaml configuration and Material-compatible classic variant, removes the unsupported contributor plugin, updates dependencies and developer commands, and changes CI publishing to GitHub Pages’ artifact-based deployment actions. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Summary
mkdocs.yamlunchanged (1:1 start, nozensical.tomlyet).theme.variant: classickeeps the Material look.git-committersplugin is removed (not supported by Zensical, not wanted).gh-deploy:docs.yamlnow deploys with the GitHub Pages actions.make docs-serve/make docs-buildrunzensical serve/zensical build --clean --strict.zensical+pymdown-extensions(lock written with uv 0.13).Before the deploy works
GitHub Pages must be set to GitHub Actions under Settings > Pages. The
gh-pagesbranch is unused afterwards.Test plan
make docs-build(strict) passes; a broken link aborts the build/llms.txtis served and identical tocliffy/llms.txtuv lock --check🤖 Generated with Claude Code
Summary by Sourcery
Switch the documentation build and publishing pipeline from MkDocs Material to Zensical while retaining the existing site appearance and strict validation.
New Features:
Enhancements:
Build:
CI:
Deployment:
Documentation:
Tests:
Chores: