Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
push:
branches:
- main
- 'release/**'
paths:
- 'docs/**'
- 'mkdocs.yml'
Expand All @@ -16,9 +15,6 @@ on:
- 'SECURITY.md'
- 'noxfile.py'
- '.github/workflows/deploy-docs.yml'
# Trigger on tags regardless of paths changed
tags:
- 'v*'
pull_request:
branches:
- main
Expand Down Expand Up @@ -77,17 +73,22 @@ jobs:
cd docs/assets/brand
zip -r ../brand-kit.zip .

- name: Set docs version for topbar
run: |
VERSION=$(python3 -c "import tomllib; print('v' + tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
echo "DOCS_VERSION=${VERSION}" >> "$GITHUB_ENV"

- name: Build Documentation
run: uv run mkdocs build --strict

- name: Deploy to Cloudflare Pages
# Allow deploy on push to main, workflow_dispatch, or version tags
# Production docs deploy only from main (or manual dispatch on main)
if: |
(github.event_name == 'push' || github.event_name == 'workflow_dispatch') &&
(github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
github.ref == 'refs/heads/main'
uses: cloudflare/wrangler-action@v3
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
# Use 'main' as the production branch for Cloudflare regardless of tag name
# Deploy production docs from the merged main branch only.
command: pages deploy site --project-name=zenzic --branch=main --commit-dirty=true
5 changes: 5 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ Copyright 2026 PythonWoods <dev@pythonwoods.dev>

This product includes software developed by the PythonWoods contributors.

Project attribution:

- Zenzic is a PythonWoods project.
- Zensical, MkDocs, and other referenced ecosystem tools are third-party projects.

================================================================================

## Runtime Dependencies
Expand Down
5 changes: 5 additions & 0 deletions README.it.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ Zenzic è **agnostico** — funziona con qualsiasi sistema di documentazione bas
sono un errore bloccante, e se dichiari `engine = "zensical"` devi avere `zensical.toml` — nessun
fallback, nessuna supposizione.

Baseline di compatibilità attuale con Zensical: **v0.0.31+**.

Attribuzione del progetto: Zenzic è un progetto PythonWoods. Zensical, MkDocs e
gli altri strumenti citati sono progetti di terze parti.

---

## v0.5.0a1 — La Sentinella
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ or a bare folder of `.md` files) without installing any build framework. And it
absolute links are a hard error, and if you declare `engine = "zensical"` you must have
`zensical.toml` — no fallback, no guessing.

Current Zensical compatibility baseline: **v0.0.31+**.

Project attribution: Zenzic is a PythonWoods project. Zensical, MkDocs, and other
referenced ecosystem tools are third-party projects.

---

## v0.5.0a1 Highlights — The Sentinel
Expand Down
3 changes: 3 additions & 0 deletions docs/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Zenzic is an engineering-grade documentation linter and quality gate for any Mar

Built by [PythonWoods](https://github.com/PythonWoods), it is designed to run in CI/CD pipelines and catch documentation issues before they reach users.

Attribution: Zenzic is a PythonWoods project. Zensical, MkDocs, and other
ecosystem tools referenced in this documentation are third-party projects.

---

<div class="grid cards" markdown>
Expand Down
3 changes: 3 additions & 0 deletions docs/it/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Zenzic è un linter di documentazione di livello ingegneristico e un quality gat

Sviluppato da [PythonWoods](https://github.com/PythonWoods), è progettato per essere eseguito nelle pipeline CI/CD e rilevare i problemi nella documentazione prima che raggiungano gli utenti.

Attribuzione: Zenzic è un progetto PythonWoods. Zensical, MkDocs e gli altri
strumenti dell'ecosistema citati in questa documentazione sono progetti di terze parti.

---

<div class="grid cards" markdown>
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ extra_css:
extra:
build_date: !ENV [BUILD_DATE, "dev"]
generator: false
version: "0.4.0rc5"
version: !ENV [DOCS_VERSION, "dev"]
social:
- icon: fontawesome/brands/github
link: https://github.com/PythonWoods/zenzic
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ exclude_lines = [
# ─── Version bumping ───────────────────────────────────────────────────────────

[tool.bumpversion]
current_version = "0.4.0rc4"
current_version = "0.5.0a1"
commit = true
tag = true
tag_name = "v{new_version}"
Expand Down