Documentation Overview
Welcome to the Zenzic documentation — the engineering-grade static analyzer for Markdown-based documentation.
Zenzic operates in the Build-Aware Gap: the critical moment between writing source files and their transformation into a website. It builds a Virtual Site Map (VSM) directly from raw Markdown source to validate links, detect orphans, scan for exposed credentials, and enforce quality rules — without ever running the documentation build.
Where to start
| Goal | Page |
|---|---|
| Install Zenzic and run your first check | First Audit |
| Understand which checks Zenzic runs | Checks Reference |
Configure zenzic.toml | Configuration Reference |
| Integrate with GitHub Actions | CI/CD Integration |
| Explore the internal architecture | Architecture Overview |
| Contribute to the project | Contributing |
Quick start
# Install
pip install zenzic
# Initialise configuration (discovers engine from config files)
zenzic init
# Run all checks
zenzic check all
"The Code is Law. The Documentation is Truth. The Sentinel is vigilant."