v0.9.0

Quality Gate Documentale
per pipeline CI/CD.

Rileva link rotti, credenziali trapelate e deriva della navigazione prima del merge.

Inizia Vedi su GitHub

100%

Deterministico

Sottoprocessi

O(N)

Motore RE2

CI/CD

Gate CI nativi

// EXECUTION_LAYER

Punto Critico

Il decadimento documentale e silenzioso. Di solito i team lo scoprono dopo il deploy.

zenzic check all · v0.9.0

✘ SECURITY BREACH DETECTED

✘ Finding: Secret detected (aws-access-key) — rotate immediately.

✘ Location: docs/deploy.md:4

✘ Credential: AKIA************MPLE

Action: Rotate this credential immediately and purge it from the repository history.

standalone • 3 files (2 docs, 1 assets) • 0.0s • 87 files/s

docs/assets/unused.png ⚠ [Z405] File not referenced in any documentation page.

docs/deploy.md:1 ⚠ [Z502] Page has only 6 words (minimum 50).

    1  ❱  # Deploy
    2  │
    3  │  ```bash

docs/index.md:1 ⚠ [Z502] Page has only 18 words (minimum 50).

    1  ❱  # Welcome
    2  │
    3  │  See the [intro page](./intro.md) for details.

docs/index.md:3:8 ✘ [Z104] './intro.md' not found in docs

    1  │  # Welcome
    2  │
    3  ❱  See the [intro page](./intro.md) for details.
       │          ^^^^^^^^^^^^^^^^^^^^^^^^
    4  │
    5  │  ![architecture](./assets/old-diagram.png)

docs/index.md:5 ✘ [Z104] './assets/old-diagram.png' not found in docs

    3  │  See the [intro page](./intro.md) for details.
    4  │
    5  ❱  ![architecture](./assets/old-diagram.png)
       │  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    6  │
    7  │  This project was migrated from **OldPlatform** in Q1 2026.

docs/index.md:7:33⚠[Z601][Z601] Obsolete or unauthorized brand term 'OldPlatform' detected. Use semantic versioning (e.g., 'vX.Y.Z') in active prose, or suppress if this is a historical ledger.

    5  │  ![architecture](./assets/old-diagram.png)
    6  │
    7  ❱  This project was migrated from **OldPlatform** in Q1 2026.
       │                                   ^^^^^^^^^^^

────────────────────────────────────────────────────────────────────────────────

Summary: ✘ 2 errors ⚠ 4 warnings 💡 0 info • 3 files with findings

FAILED: Hard errors detected. Exit code 1 is mandatory.

Refer to https://zenzic.dev/docs/reference/finding-codes for remediation · Try 'zenzic check --help' for options.

🔒 Suppression Audit: 0/30 (inline: 0, per-file: 0)

Z104File non trovato→Z201Leak credenziali (exit 2)→Z405Asset inutilizzato→Z502Contenuto troppo breve→Z601Marchio obsoleto→

// FAILURE_TOPOLOGY

Esito

Zenzic in Azione Il gate CI blocca le regressioni prima del merge.

I finding sono deterministici per file e riga. Exit code 1 blocca il debito documentale e il modello DQS flat-cost mantiene esplicito il debito da soppressioni.

Contesto finding deterministico

Ogni finding mostra il contesto della riga sorgente. Il team puo correggere senza cercare nei log.

docs/guide.md

✘[FILE_NOT_FOUND]'intro.md' non raggiungibile dalla navigazione (produrrebbe 404)

15│ prima di continuare.

16❱ Consulta la pagina di avvio per i dettagli.

17│ Poi configura il tuo ambiente.

Leak credenziali bloccato (exit 2)

Scansiona ogni riga, inclusi i blocchi <code>bash</code> e <code>yaml</code>, per credenziali trapelate. Il codice di uscita <code>2</code> è riservato agli eventi di sicurezza.

VIOLAZIONE SICUREZZA RILEVATA

✘Trovato:GitHub token detected

✘Posizione:docs/tutorial.md:42

✘Credenziale:ghp_************3456

Azione:Ruota questa credenziale immediatamente e rimuovila dalla cronologia del repository.

Riepilogo esito gate

Ogni esecuzione termina con uno stato compatto. Il codice di uscita 1 indica merge bloccato da finding di qualita.

✘ 2 errori⚠ 1 avviso• 1 file con rilevamenti

FALLITO: quality gate ha bloccato il merge (exit code 1).

// DIAGNOSTIC_OUTPUT

Ecosistema

Esegui lo stesso quality gate su stack documentali diversi. Docusaurus, MkDocs, Zensical e repository standalone.

Gli adapter normalizzano i controlli di path e topologia per mantenere il comportamento CI deterministico.

Adapter Docusaurus

Valida link interni, anchor e topologia di navigazione partendo dal sorgente Markdown e dalla configurazione Docusaurus.

docusaurus.config.ts · adapter run

# Docusaurus project
uvx zenzic check all .

# Outcome
# exit 0 -> no blocking findings
# exit 1 -> quality gate blocks merge

Adapter MkDocs

Legge la topologia di navigazione MkDocs e controlla il sorgente Markdown direttamente, senza richiedere una build del sito.

mkdocs.yml · adapter run

# MkDocs project
uvx zenzic check all .

# Same gate semantics as Docusaurus
# deterministic findings, same exit codes

Adapter Zensical

Usa la configurazione zensical per validare vincoli strutturali e di contenuto con reporting deterministico.

zensical.toml · adapter run

# Zensical project
uvx zenzic check all .

# Output is machine-readable and human-readable
# for CI and local review

Repository Markdown Standalone

Esegue i controlli anche su repository senza framework dedicato, validando direttamente file Markdown e riferimenti interni.

standalone repository · adapter run

# Plain Markdown repository
uvx zenzic check all docs/

# Use in CI, pre-commit, or local checks
# without changing repository structure

// ADAPTER_SURFACE

Avvio Rapido

Installazione rapida: esegui un comando.

Esegui audit della documentazione e ottieni codici di uscita deterministici per CI.

zenzic · quickstart

✓zenzic · python 3.10+ · pronto

# esegui il quality gate documentale

$uvx zenzic check all

# exit 0: nessun finding bloccante

# exit 1: il quality gate blocca il merge

Leggi la documentazione completa →Star su GitHub

Enterprise

Governance Enterprise e Scoring

Monitora il debito di soppressione, applica le policy di qualità e governa la salute della documentazione tra team e repository.

// GOVERNANCE_GATE

Metriche di Qualità

Punteggio di Qualità Controllo salute deterministico, per commit.

Monitora un punteggio deterministico in CI per bloccare le regressioni. Una visione olistica ed elegante della salute della tua documentazione.

Metriche

Salute Complessiva

+2%

Comando CI

zenzic score --save

Salute Link Interni

Stabilità anchor

100

Riferimenti esterni

Rilevamento Orfani

Asset inutilizzati

Isolamento navigazione

100

// SUPPRESSION_POLICY

Governance

CAP Soppressioni — Anteprima Live

Quando le soppressioni attive superano il CAP configurato, zenzic-action scrive questo riepilogo direttamente nel pannello del job di GitHub Actions. Nessun log da scavare.

CAP superato — exit 1

✘ Suppression CAP Exceeded+13

Active suppressions43

CAP limit30

Excess debt+13

📋 Remediation Playbook →

CAP nei limiti — exit 0

✔ Suppression CAP — Within Limit

Active suppressions18