Proof of concept: Zensical documentation site - #643
Open
PierreLapolla wants to merge 1 commit into
Open
PierreLapolla wants to merge 1 commit into
PierreLapolla wants to merge 1 commit into
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
1 participant
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.
This PR adds a Zensical documentation site under
docs/.This is a proof of concept, not a finished/reviewed documentation set.
The Markdown pages in
docs/were generated by an AI assistant (Claude),which translated the existing
README.mdinto a multi-page site structure(guide + API reference).
README.mditself was not modified and remainsthe source of truth, the new pages are a derivative reformatting of it.
Running the docs site locally
Zensical needs uv
uv run zensical serve # live-reload dev server, defaults to http://localhost:8000New CI: GitHub Pages deploy
This PR also adds
.github/workflows/docs.yml, a new workflow that did not exist before:main/masterzensical, runszensical build --clean, and deployssite/to GitHub Pagespages: write/id-token: writepermissions (already scoped in the workflow) and GitHub Pages enabled on the repo (Settings > Pages > Source: GitHub Actions). Maintainers will need to turn this on, it won't deploy anything until then.