Skip to content

Releases: PythonWoods/zenzic-doc

zenzic-doc 0.10.4 — Wordmark, blog post & security fixes

09 Jun 18:13
c2ae13f

Choose a tag to compare

What's changed

Documentation

  • New "Auditing the Auditors" case study blog post — covers the CI self-check incident and resolution
  • New zenzic-doc SVG wordmark logo (light + dark) in official sky brand palette
  • All badges centered with <p align="center"> in both README.md and README.it.md
  • SSH commit signing setup instructions added to CONTRIBUTING.md

Security

  • shell-quote CRITICAL (GHSA-w7jw-789q-3m8p) resolved via npm audit fix
  • actions/checkout pinned to v6.0.3 SHA across all 9 workflows

CI

  • Removed pull_request.paths filter from ci.yml — fail-closed: required checks now always created for every PR
  • Added Z109 suppression for github.com/google/re2 transient connection errors in architecture.mdx (EN + IT)

Full changelog

https://github.com/PythonWoods/zenzic-doc/blob/main/CHANGELOG.md

v0.10.3: Z-Code Gallery Updates & Contributor Portal Hardening

08 Jun 19:15
eb969e8

Choose a tag to compare

This release updates the documentation portal to reflect the core linter enhancements of v0.10.3 and establishes new contributor guidelines aligned with enterprise standards.

📖 Documentation Impact Analysis (D.I.A.)

  • Z-Code Gallery Routing: Updated the English and Italian reference documentation for Z102 (Anchor Missing), Z104 (File Not Found), and Z503 (Snippet Error) to document explicit anchors, footnote parsing, and custom YAML tag support.
  • Diátaxis Compliance: Preserved the dry, lookup-only structure of finding-codes.mdx by routing detailed parser specs and examples exclusively to the tutorials gallery.

🛡️ Contribution Guidelines & Workflows

  • Developer Portal Upgrade: Aligned the developer portal (pull-requests.mdx and index.mdx) and repository CONTRIBUTING.md / CONTRIBUTING.it.md guides to enforce the Issue-First Policy, mandatory GPG/SSH/S/MIME signatures, DCO sign-offs, and "No AI Slop" checks.
  • Compliance Workflow: Integrated automated PR title linting and DCO validation into the repository's CI pipeline.

v0.10.1: Diátaxis Alignment & CI Naming Contract

07 Jun 15:12
cd99bfd

Choose a tag to compare

What's New in v0.10.1

This release brings the official documentation perfectly in line with the Diátaxis framework boundaries and enforces the new organizational CI/CD naming standards.

Documentation & Diátaxis

  • Reference Purity: Audited and purified the docs/reference/ quadrant. All philosophical explanations and step-by-step guides have been successfully migrated out of Reference files.
  • Explanation Quadrant Alignment: Audited docs/explanation/ to ensure purely theoretical and architectural content without CLI execution steps.
  • Tutorials & How-To: Audited the practical guides to remove deep theory and exhaustive tables, enforcing strict problem-oriented learning structures.

CI/CD & Governance

  • Global CI Naming Contract: Aligned all GitHub Actions workflow files to the organizational naming standard (e.g., Zenzic Docs CI, Run Zenzic Quality Gate, Verify Badge Freshness).
  • Gateway Contribution Policy: Removed duplicated workflow texts from CONTRIBUTING.md, transforming it into a strict pointer (Gateway) to the official developer documentation to prevent DRY violations.
  • TOML Configuration Hardening: Restructured .zenzic.toml to enforce TOML parsing strictness, ensuring root keys (like strict and fail_under) are physically declared before any nested headers.

Full Changelog: v0.10.0...v0.10.1

v0.10.0 (Diamond)

06 Jun 19:10
a6526c0

Choose a tag to compare

Added

  • Native CI Integration and Filtering Docs: Documented the new --ci shorthand and --format github-annotations in CLI Reference and CI/CD integration guides (EN + IT). Documented the --only flag for targeted rule filtering.
  • Blog Post: Added new DevRel payload "Zenzic v0.10.0: Native GitHub Annotations and Progressive Adoption" demonstrating the killer features of v0.10.0.

Changed

  • ADR-037 Install Guide Refinement: Removed the hardcoded version tag (@v0.10.0) from the Ephemeral GitHub execution instructions (uvx --from git+...) to decouple the command from temporal releases and point to the default branch.

v0.9.2 (Graphite)

05 Jun 18:50
5cab64f

Choose a tag to compare

v0.9.2 (Graphite)

This release delivers a complete structural overhaul of the documentation portal, strictly aligning it with the Diátaxis framework and standardizing the UI components.

Changed

  • Architecture: Realigned all documentation into strict Diátaxis quadrants (Tutorials, How-To, Reference, Explanation).

v0.9.1 - Graphite

02 Jun 18:17
3142865

Choose a tag to compare

Zenzic Doc v0.9.1 "Graphite"

This release matches the Zenzic core release under the branch parity rule, completing the Z-Code Gallery documentation and stabilizing the CI audit pipeline.

What's Changed

Added

  • Z-Code Gallery Completion: Full documentation and interactive examples (EN + IT locales) for Z107 CIRCULAR_ANCHOR and Z104 FILE_NOT_FOUND.

Changed

  • Repository-Relative Suppression Config: Updated .zenzic.toml per_file_ignores and directory_policies to use strictly repository-relative keys (prefixed with docs/ or docs/it/).
  • Strategic Navigation Exemption: Added directory_policies exemption for docs/tutorials/examples/** under Z401 to prevent scoring penalties on example directories that intentionally lack index files.
  • Score Badge Telemetry: Stamped quality score badge inline in README.md and README.it.md to show a passing score of 96/100.
  • Hostile Precision UI standardization applied across release-facing documentation surfaces.
  • Normalized legacy snippets and inconsistent command narratives in terminal documentation.
  • SVG asset governance aligned with ADR-037 compliance requirements.

Infrastructure & CI/CD

  • Branch Parity CI Fix: Resolved the remote branch resolution bug in .github/workflows/ci.yml by using github.head_ref instead of github.base_ref. This ensures Pull Requests correctly checkout the corresponding development branch (release/v0.9.1-prep) of the zenzic core engine, guaranteeing that path matching alignments work seamlessly in CI checks.

For a complete migration history, see the Changelog.

v0.9.0 — Lab Gallery & Privacy Gate Documentation

31 May 17:53
df7998b

Choose a tag to compare

What's new in v0.9.0

Lab gallery documentation

  • tutorials/examples.mdx (EN + IT): full prose gallery for all 20 zenzic lab sandboxes with scenario matrix, exit-code column, and per-scenario descriptions.
  • 15 new gallery sections covering z102, z103, z105, z108, z202, z204, z301, z302, z303, z402, z403, z501, z502, z503, z505.

CLI output alignment

  • finding-codes.mdx (EN + IT): Z204 output updated to POLICY VIOLATION DETECTED banner (matches actual CLI).
  • privacy-gate.mdx (EN + IT): new Exit Behavior section; [core] table-header corrected.

Developer docs

  • Local gate sequence now mirrors the real just verify recipe (pre-commit hooks → pytest → strict audit → score stamp → freshness gate).
  • Developer command matrix cleaned up; obsolete preflight terminology removed.

Full changelog: CHANGELOG.md

Docs v0.7.1 — Pipeline Unification & Parity Guard

09 May 15:44
1fc5ffe

Choose a tag to compare

This release aligns the documentation infrastructure with Zenzic Core v0.7.1. It streamlines the CI/CD pipeline and introduces strict parity checks to ensure the documentation always matches the underlying code.

Added

  • Doc-Code Parity Gate: Introduced the verify-codes-parity check. The CI now strictly validates that every Zxxx error code implemented in the Zenzic Core is accurately documented in both the English and Italian reference manuals.
  • Graceful Degradation: The parity checker automatically falls back to downloading the stable Zenzic release from PyPI if a local development core is not found, easing the workflow for external contributors.
  • I18N Parity Documentation: Formally documented the Z907 (I18N Parity) rule.

Changed

  • Pipeline Efficiency: Removed double-execution of typechecks and Sentinel guards. The just verify command is now the single, unified entry point for validation.
  • Modernized References: Updated historical references in checks.mdx to reflect the current Z1xx namespace, purging legacy phantom codes.

v0.7.0 — Quartz Maturity (Stable)

07 May 18:30
dd512f7

Choose a tag to compare

The zenzic-doc portal reaches Quartz Maturity alongside the Core.

What's new

  • SentinelOutput v2status discriminant replaces variant. code, exitCode, traceability props enforce Absolute Traceability from documentation prose to Zxxx finding code.
  • VSMVisualizer — in-place-expandable Virtual Site Map tree distinguishing physical nodes (📄), virtual routes (🏷 🔖 👤), and Reverse-Mapping violations (⚠).
  • EPOCH 7a documentation — dual-track (user/developer) coverage of Multi-Root Discovery: blog auto-discovery, ContentRoot dataclass, four-stage pipeline.
  • Diátaxis architecture — full restructure of the information hierarchy into tutorials, how-to, reference, and explanation tracks.
  • Zenzic Blog — six founding articles inaugurating the engineering log at /blog/.
  • Brand systemstatic/assets/brand/brand-kit.zip with SVG, PNG, and social card templates.
  • Editorial precision — constraint language replaces marketing prose site-wide (Sprints A–C, EN+IT).

Compliance

zenzic check all --strict exits 0 with zero findings on every push.
207/207 REUSE-compliant files. Bilingual parity (EN+IT) enforced.

Full changelog: CHANGELOG.md

What's Changed

  • release: v0.7.0 — Quartz Maturity (Stable) — Documentation Portal by @PythonWoods-Dev in #34
  • release: v0.7.0 — Quartz Maturity (Stable) — Documentation Portal by @PythonWoods-Dev in #44

Full Changelog: v0.6.1...v0.7.0

v0.6.1 "Obsidian Glass" — [SUPERSEDED by v0.7.0]

21 Apr 18:01
e753e8c

Choose a tag to compare

Warning

[SUPERSEDED by v0.7.0] — This release is deprecated. All users must upgrade to v0.7.0 "Obsidian Maturity". Please see the v0.7.0 release.


🛡️ The Documentation has reached Stable Status.

This release marks the structural and visual inauguration of the Zenzic
Documentation Portal, synchronized with the v0.6.1 Obsidian Glass stable core.

Key Structural Innovations:

  • Diátaxis Framework: Fully reorganized content into four functional
    quadrants: Tutorials, How-to Guides, Reference, and Explanation.
  • Obsidian Engineering Ledger: A new visual standard for the Landing Page,
    showcasing our architectural invariants (Zero Assumptions, Subprocess-Free,
    Deterministic Compliance).
  • Standalone Mode Rebranding: Complete transition from "Vanilla" to
    "Standalone Mode", reflecting technical honesty and structural transparency.
  • Traceable Integrity: Authoritative index of Zxxx finding codes with
    deep-link support for instant resolution.

Technical Hardening:

  • SEO & Search Console Fixes: Implemented root index and directory
    integrity checks to eliminate 404 errors.
  • Social Presence: High-fidelity Open Graph assets for X and LinkedIn.
  • Bilingual Excellence: 100% parity between English and Italian sources.