Open
Switch documentation toolchain from MkDocs 1.x to Zensical#24
Conversation
Co-authored-by: cvraut <10603882+cvraut@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation to use zensical instead of mkdocs 1.0
Switch documentation toolchain from MkDocs 1.x to Zensical
Mar 9, 2026
wndyy
marked this pull request as ready for review
June 6, 2026 19:14
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.
MkDocs 1.x is sunsetted and the draft docs PR (#23) pinned
mkdocs<2to avoid breakage. This replaces that setup with Zensical — a modern static site generator from the creators of Material for MkDocs — removing the version pin entirely.Config
mkdocs.yml(YAML) withzensical.toml(TOML) — equivalent nav, dark/light palette toggle, and feature flags (navigation.tabs,navigation.sections,content.code.copy, etc.)CI
.github/workflows/docs.yml: installszensical, runszensical build --clean, deploys to GitHub Pages viaupload-pages-artifact+deploy-pagesDocs content
docs/index.md,docs/api.md, and platform guides for Discord, Slack, Webex, and Microsoft TeamsWarning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
zensical.com/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)zensical.org/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.