Z502: SHORT_CONTENT

Severity: warning Penalty: 1.0 point Category: content Auto-fixable: No

Rationale

This rule is triggered when a published documentation page contains fewer words than the required minimum word count threshold (default: 50 words), indicating incomplete stub documentation.

How to Fix

Inspect the flagged location in the Markdown file and update the content or configuration:

Bad (Triggers Z502)

# Quick Start

This is a stub page.

Good (Resolves Z502)

# Quick Start

Welcome to Zenzic! Follow the installation steps below to set up your environment, initialize configuration, and execute your first documentation audit scan across your repository.

Configuration

# .zenzic.toml - Adjust minimum word count threshold
min_word_count = 50

Reference

See the Finding Codes Index for finding code details.