Migrate documentation toolchain from MkDocs/Material to Zensical#36
Merged
Conversation
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.
Migrates the project's documentation pipeline from MkDocs + Material for MkDocs to Zensical, as per ADR-0001.
Changes
.github/workflows/documentation.yml: Replacemkdocs gh-deploy --forcewithzensical build+peaceiris/actions-gh-pages@v4for GitHub Pages deployment. RemoveConfigure Git Credentialsstep (handled by the action). Update pip cache key tozensical-.doc/4-tooling.md: Update local dev instructions — installzensical==0.0.46instead ofmkdocs-material, usezensical serveinstead ofmkdocs serve.AGENTS.md: Update generator and theme references.Notes
mkdocs.ymlis left untouched — Zensical reads it as-is.0.0.46) to avoid breakage from alpha releases.peaceiris/actions-gh-pagespublishes./siteto thegh-pagesbranch.