Skip to main content

Why Zenzic — Risk Prevention and Deterministic Quality Gates

Zenzic is a high-performance documentation linter for any Markdown-based project. It operates on raw source files — never the generated output — so it works with any build engine (MkDocs, Zensical, or others via the adapter system). It detects broken links, orphan pages, placeholder stubs, unused assets, and leaked credentials before the build runs.

Zenzic exists to prevent documentation defects from entering the main branch. The objective is operational: block regressions before release, reduce security exposure, and keep CI outcomes deterministic.

Business Value​

1. Risk Reduction​

Zenzic prevents high-impact documentation failures before deployment:

  • broken internal links that become production 404s,
  • leaked credentials in Markdown or code blocks,
  • navigation or topology inconsistencies that hide critical pages.

For public repositories, credential detection (Z2xx) is a direct control against accidental secret exposure.

2. Time Savings​

The quality gate automates checks that are often done manually during review.

Correct framing: the automated quality gate prevents documentation debt from entering the main branch, removing manual review loops for broken links.

Teams stop spending review cycles on repetitive defects and can focus on content quality.

3. Reliability​

Reliability means repeatable outcomes from identical inputs. Zenzic enforces deterministic analysis and deterministic exit codes so CI behavior is stable across runs and environments.

Defence Trinity​

Internal links, anchors, and route references are validated before build. This prevents runtime navigation failures from reaching users.

Credential Leak Prevention (Z2xx)​

The scanner checks each file for known credential patterns. Security findings are fail-closed and immediately stop the pipeline.

Path and Topology Safety (Z202/Z203)​

Path traversal and unsafe path resolution are blocked. Configuration cannot escape repository boundaries during analysis.

Deterministic Execution Model​

Zenzic applies three engineering rules to keep results predictable:

  1. Lint source, not build output.
  2. No subprocesses in the core analysis loop.
  3. Pure-function-first validation and scoring.

This model keeps the same repository state tied to the same finding set and the same gate result.

CI Gate Semantics​

  • Exit 0: no blocking findings.
  • Exit 1: quality findings block merge.
  • Exit 2: credential/security finding.
  • Exit 3: path traversal guard violation.

The DQS flat-cost model keeps suppression debt explicit: each suppression contributes a fixed penalty, so score movement is predictable and reviewable.

Use Cases​

  • B2B monorepo maintenance: enforce consistent doc quality across multiple services.
  • API portal validation: prevent broken route references and hidden navigation regressions.
  • Docs-as-code CI pipelines: block regressions early with deterministic gate behavior.