Skip to content

Switch documentation toolchain from MkDocs 1.x to Zensical - #24

Open
cvraut with Copilot wants to merge 2 commits into
mainfrom
copilot/update-documentation-tool
Open

Switch documentation toolchain from MkDocs 1.x to Zensical#24
cvraut with Copilot wants to merge 2 commits into
mainfrom
copilot/update-documentation-tool

Conversation

Copilot AI commented Mar 9, 2026

Copy link
Copy Markdown
Contributor

MkDocs 1.x is sunsetted and the draft docs PR (#23) pinned mkdocs<2 to 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

  • Replaced mkdocs.yml (YAML) with zensical.toml (TOML) — equivalent nav, dark/light palette toggle, and feature flags (navigation.tabs, navigation.sections, content.code.copy, etc.)

CI

  • Updated .github/workflows/docs.yml: installs zensical, runs zensical build --clean, deploys to GitHub Pages via upload-pages-artifact + deploy-pages
-      - run: pip install "mkdocs-material" "mkdocs<2"
-      - run: mkdocs build --strict
+      - run: pip install zensical
+      - run: zensical build --clean

Docs content

Warning

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
    • Triggering command: /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
    • Triggering command: /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.

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
wndyy marked this pull request as ready for review June 6, 2026 19:14
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.

2 participants