How-To Guides¶
Task-oriented, step-by-step instructions for installing, configuring, automating, and extending Zenzic across your documentation projects.
Getting Started & Core Setup¶
-
Install Zenzic globally via
uv tool, ephemerally viauvx, or locally withpip. -
Scaffold and fine-tune your project's
.zenzic.tomlpolicy file withzenzic init. -
Configure real-time in-editor diagnostics, LSP auto-provisioning, and code actions.
Pipelines & Automation¶
-
Enforce zero-regression gates in GitHub Actions, GitLab CI, and custom CI pipelines.
-
Integrate sub-50ms secret scanning and fast link linting on staged files.
-
:material-shield-badge-outline:{ .lg .middle style="color: #0284c7;" } DQS Status Badges
Generate and stamp live Document Quality Score shields directly into your
README.md.
Governance & Quality Management¶
-
Audit suppressions, enforce directory policies, and manage the strict
suppression_cap. -
Protect private repositories with offline verification and polyglot secret scanning.
-
Manage external HTTP link timeouts, domain exclusion lists, and offline builds.
-
Configure brand term dictionaries and eradicate obsolete product naming conventions.
-
Validate OpenGraph social cards, meta descriptions, and sitemap topology.
Extensibility & Migration¶
-
Author deterministic custom rules using the Python Custom Rule SDK v3.
-
Migrate documentation seamlessly between MkDocs, Zensical, and Docusaurus.
-
Comprehensive runbook for diagnosing CI timeouts, cache invalidation, and rule alerts.