red-hat-developers-documentation-rhdh

Populate JTBD navigation map files with actual include directives from Jira tickets or category/job/topic names. Use when mapping content for a JTBD job, populating nav files, or connecting existing modules to the JTBD structure.

Finds orphaned .adoc and image files not referenced by any include or image directive. Use when cleaning up unused files or after restructuring content.

Validates directory naming conventions for titles, assemblies, and modules. Use when restructuring content or adding new directories.

Runs Vale DITA compliance checks using .vale-dita-only.ini. Use when validating AsciiDoc DITA standards compliance.

Validates assembly files follow the modular docs template structure. Use when creating or restructuring assemblies.

Validates modular docs metadata, prefix conventions, and list formatting in .adoc files. Use when creating or editing modules.

Validates modules follow Red Hat modular docs templates. Use when creating new modules or fixing template compliance.

Validates all mandatory modular doc elements are present per content type. Use when modules are missing required sections.

Validates assembly scope limits for nested assemblies and total includes. Use when assemblies grow too large.

Validates maximum heading depth does not exceed 3 levels. Use when deep heading nesting is detected.

Validates abstract content is not self-referential. Use when editing short descriptions or abstracts.

Validates short description formatting including abstract marker, spacing, and length. Use when editing abstracts or module structure.

Validates procedure titles use imperative mood, IDs match titles, and filenames match IDs. Use when editing titles or renaming files.

Validates prerequisites section format in procedure files. Use when editing prerequisites or creating new procedures.

Runs Vale grammar and style checks using .vale.ini (errors only). Use when checking prose quality and style compliance.

Validates that file content matches its declared content type and filename prefix. Use when content type mismatches are suspected.

Detects broken include and image targets that reference non-existent files. Use when restructuring content or after file renames.

Detects deleted or renamed titles that may need URL redirects. Use after renaming or removing titles.

Detects hardcoded product names that should use AsciiDoc attribute references. Use when product names are hardcoded in content.

Detects files mentioning Technology or Developer Preview without official disclaimer snippets. Use when adding preview feature content.

Orchestrates all 19 CQA checks in optimal workflow order for a documentation title. Use when asked to run CQA compliance, audit a title, or check documentation quality.

Update CQA reference materials (SSG, peer review guide, modular docs, Vale styles). Use before starting a CQA audit or when resources may be stale.