Skip to content

Migrate documentation toolchain from MkDocs/Material to Zensical#36

Merged
gabrielbmoro merged 1 commit into
mainfrom
feature/update-mkdocs-to-zensical
Jul 4, 2026
Merged

Migrate documentation toolchain from MkDocs/Material to Zensical#36
gabrielbmoro merged 1 commit into
mainfrom
feature/update-mkdocs-to-zensical

Conversation

@gabrielbmoro

Copy link
Copy Markdown
Collaborator

Migrates the project's documentation pipeline from MkDocs + Material for MkDocs to Zensical, as per ADR-0001.

Changes

  • .github/workflows/documentation.yml: Replace mkdocs gh-deploy --force with zensical build + peaceiris/actions-gh-pages@v4 for GitHub Pages deployment. Remove Configure Git Credentials step (handled by the action). Update pip cache key to zensical-.
  • doc/4-tooling.md: Update local dev instructions — install zensical==0.0.46 instead of mkdocs-material, use zensical serve instead of mkdocs serve.
  • AGENTS.md: Update generator and theme references.

Notes

  • mkdocs.yml is left untouched — Zensical reads it as-is.
  • Zensical version is pinned (0.0.46) to avoid breakage from alpha releases.
  • peaceiris/actions-gh-pages publishes ./site to the gh-pages branch.

@gabrielbmoro
gabrielbmoro merged commit e79414e into main Jul 4, 2026
2 checks passed
@gabrielbmoro
gabrielbmoro deleted the feature/update-mkdocs-to-zensical branch July 4, 2026 18:19
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