Documentation Quality Gate

Purpose

This repository uses a lightweight documentation quality gate to reduce accidental privacy, credential and overclaiming risks in technical documentation.

The goal is not to create a heavy compliance platform. The goal is to keep the documentation hub safe, reviewable and reusable.

What the gate checks

The validator checks Markdown files for:

• private key material
• likely API keys, access tokens or client secrets
• public credential identifiers that should be omitted or redacted
• Microsoft credential-style identifiers that should not be stored in this repository
• unscoped production-readiness claims
• unscoped enterprise-readiness claims
• certification wording without clear context
• missing documentation boundary sections in longer files under docs/

Required documentation boundary style

Longer technical documents under docs/ should usually include at least one of these sections:

## Scope
## Non-goals
## Public/private boundary
## What this is not

This keeps the repository aligned with the hub principle:

Technical documentation should be useful without exposing private environments or overclaiming maturity.

Public/private boundary

This quality gate is intended to prevent documentation from accidentally including:

• real customer data
• real production domain names
• secrets or credentials
• certificate or credential IDs
• internal ticket contents
• private incident details
• claims that a lab or portfolio project is production-ready when it is not

How to run locally

From the repository root:

python tools/validate_documentation_quality.py

Expected result:

DOCUMENTATION QUALITY GATE: PASSED

CI workflow

The GitHub Actions workflow is located at:

.github/workflows/documentation-quality-gate.yml

The workflow runs on Markdown documentation changes and on manual dispatch.

Non-goals

This gate does not replace:

• human review
• official security scanning
• secret scanning from GitHub or other tools
• customer-specific documentation review
• legal or compliance review
• production change management

It is a lightweight repository-specific guardrail for documentation hygiene.