rh-ssg-formatting

Name: rh-ssg-formatting
Availability: InStock
Author: redhat-documentation

Official

Ensure Red Hat docs meet style guide.

Content & Communication #documentation #content review #formatting #style guide #ssg #red hat

Authorredhat-documentation

Version1.0.0

Installs0

System Documentation

What problem does it solve?

This Skill helps ensure that Red Hat documentation adheres to the strict formatting and style guidelines outlined in the Red Hat Supplementary Style Guide, preventing common errors and improving consistency.

Core Features & Use Cases

Code Block Formatting: Verifies that commands, inputs, and outputs are correctly formatted within code blocks.
User-Replaced Values: Checks that placeholders for user-specific information use the correct syntax (e.g., <value>).
Title and Product Naming: Ensures titles use sentence-style capitalization and product names/versions are referenced via attributes.
Date and Man Page Formatting: Validates standard date formats and man page reference syntax.
Use Case: Before publishing a new article, use this Skill to automatically scan it for any deviations from the Red Hat SSG, such as incorrect use of bolding in code blocks or improper formatting of user-replaceable values.

Quick Start

Review the formatting of the attached document for SSG compliance.

Dependency Matrix

Required Modules

None required

Components

references