Repository navigation
docs!: build and version the online documentation with Zensical - #502
Merged
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.
What
Moves the online documentation from MkDocs (+ Material) to Zensical, keeping the same content, navigation and
mike-style versioning on thegh-pagesbranch.docs-onlinegroup is nowzensical,mkdocstrings-pythonandmike.mikecomes from Zensical's compatible fork ([tool.uv.sources], pinned byuv.lock). Zensical has no native versioning yet; this is the documented bridge and writes the samegh-pages/versions.jsonlayout, so existing versions are kept.mkdocs.yaml→mkdocs.yml(the name Zensical andmikelook for); the existing config is otherwise unchanged.package/export docrunszensical build.mkdocs,mkdocs-material,mkdocs-git-revision-date-localized-plugin(and itsgitpythonetc.). The "last updated" date on pages goes away; Zensical has no equivalent plugin yet.Testing
uv lockregenerated;uv run --locked --group docs-online python package/export docbuilds with "No issues found" and leaves tracked files unchanged.mike deploy/serveflow tried locally with the fork.Risks
mikefork is a git dependency, described upstream as temporary.docsworkflow deploysdevon the next push tomaster, which is a good first check of the result before the 0.36 release deploy.🤖 Generated with Claude Code