Skip to content

docs: add zensical documentation site (GitHub Pages)#80

Merged
Toilal merged 6 commits into
developfrom
docs/zensical-site
Jul 5, 2026
Merged

docs: add zensical documentation site (GitHub Pages)#80
Toilal merged 6 commits into
developfrom
docs/zensical-site

Conversation

@Toilal

@Toilal Toilal commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Adds a zensical (Material) documentation site published to GitHub Pages.

  • Config in the native zensical.toml format; content under docs/; docs dependency group (zensical); Documentation section added to the README.
  • Three GitHub Actions workflows deploying to gh-pages via JamesIves/github-pages-deploy-action:
    • zensical.yml — push to main → site root
    • zensical-develop.yml — push to develop/dev/
    • zensical-preview.ymldocs/* PRs → /preview/<slug>/ (cleaned up on close)
  • zensical build --strictNo issues found. site/ is gitignored.

⚠️ To serve the site, enable Pages → Source = gh-pages and Actions → Workflow permissions = Read and write in the repo settings.

🤖 Generated with Claude Code

@Toilal Toilal force-pushed the docs/zensical-site branch from 981e299 to 1ea375d Compare July 4, 2026 23:13
zensical (Material) site configured via native zensical.toml, deployed to
GitHub Pages by three workflows: stable site on main, develop preview under
/dev/, and per-PR previews for docs/* branches under /preview/<slug>/.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DgcYQy7Mnh2afkmSg295uU
@Toilal Toilal force-pushed the docs/zensical-site branch from 1ea375d to 180c8e2 Compare July 4, 2026 23:22
Toilal and others added 5 commits July 5, 2026 01:30
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DgcYQy7Mnh2afkmSg295uU
GitHub Pages runs Jekyll on branch-deployed sites by default, which can
break the static zensical output. Emitting site/.nojekyll on every build
makes the main deploy publish it at the gh-pages root.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DgcYQy7Mnh2afkmSg295uU
Latest PyPI version, license, CI build status, coverage and semantic-release
badges, matching the guessit style, on both the README and the docs index.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DgcYQy7Mnh2afkmSg295uU
Standardise on Codecov across all projects. The CI now emits coverage.xml
and uploads it with codecov/codecov-action; the README and docs badges point
to Codecov accordingly.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DgcYQy7Mnh2afkmSg295uU
Grant id-token: write to the coverage job and set use_oidc on
codecov-action, so uploads authenticate through GitHub OIDC once the
Codecov GitHub App is installed — no CODECOV_TOKEN secret required.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DgcYQy7Mnh2afkmSg295uU
@codecov

codecov Bot commented Jul 5, 2026

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@Toilal Toilal merged commit e27ff85 into develop Jul 5, 2026
52 checks passed
@Toilal Toilal deleted the docs/zensical-site branch July 5, 2026 06:56
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