Skip to content

Build the docs with Zensical instead of mkdocs-material - #62

Merged
jaykv merged 1 commit into
mainfrom
chore/zensical
Oct 12, 2026
Merged

jaykv merged 1 commit into
mainfrom
chore/zensical

Conversation

@jaykv

@jaykv jaykv commented Oct 12, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • The docs are built with Zensical, which reads mkdocs.yaml unchanged (1:1 start, no zensical.toml yet). theme.variant: classic keeps the Material look.
  • The git-committers plugin is removed (not supported by Zensical, not wanted).
  • Zensical has no gh-deploy: docs.yaml now deploys with the GitHub Pages actions.
  • make docs-serve / make docs-build run zensical serve / zensical build --clean --strict.
  • Docs dependency group: 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-pages branch is unused afterwards.

Test plan

  • make docs-build (strict) passes; a broken link aborts the build
  • /llms.txt is served and identical to cliffy/llms.txt
  • uv 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:

  • Build and deploy the documentation site with Zensical and GitHub Pages’ native deployment workflow.

Enhancements:

  • Preserve the existing Material-style appearance through Zensical’s classic theme variant.
  • Remove the unsupported GitHub committers integration from the documentation configuration.

Build:

  • Update documentation development commands and dependencies to use Zensical with strict, clean builds.

CI:

  • Replace branch-based documentation deployment with GitHub Pages artifact upload and deployment actions.

Deployment:

  • Require GitHub Pages to use the GitHub Actions deployment source.

Documentation:

  • Update contributor documentation to describe Zensical as the documentation build tool.

Tests:

  • Ensure documentation builds remain strict and validate links and generated content.

Chores:

  • Refresh the uv lockfile for the updated documentation dependencies.

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>
@coderabbitai

coderabbitai Bot commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c8755348-4c04-4b65-a37a-bf44488865f0

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai

sourcery-ai Bot commented Oct 12, 2026

Copy link
Copy Markdown

Sorry @jaykv, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 6 days and 19 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Oct 12, 2026

Copy link
Copy Markdown

Reviewer's Guide

The 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

Change Details Files
Replace MkDocs Material builds with Zensical while preserving the existing configuration and visual theme.
  • Switch local serving and strict, clean builds to Zensical commands.
  • Add the classic theme variant and remove the unsupported git-committers plugin.
  • Replace MkDocs-specific documentation dependencies with Zensical and pymdown-extensions, and regenerate the uv lockfile.
Makefile
mkdocs.yaml
pyproject.toml
uv.lock
docs/project/contributing.md
Move documentation publishing from the gh-pages branch workflow to native GitHub Pages deployment.
  • Build the site in CI with Zensical and upload the generated site artifact.
  • Deploy through configure-pages and deploy-pages with GitHub Pages permissions and environment metadata.
  • Remove Git credential setup, gh-deploy, and the committers API token; require Pages to be configured for GitHub Actions.
.github/workflows/docs.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@jaykv
jaykv merged commit 94f5905 into main Oct 12, 2026
9 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