rh-ssg-technical-examples
OfficialEnsure Red Hat docs meet style guide.
Content & Communication#code review#documentation#style guide#syntax highlighting#red hat#technical examples
Authorredhat-documentation
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill ensures that technical examples in Red Hat documentation adhere to the Supplementary Style Guide, preventing common errors in command syntax, IP address usage, and code block formatting.
Core Features & Use Cases
- Root Privilege Command Check: Verifies correct
sudousage and prompt indicators. - YAML Ellipsis Validation: Ensures proper formatting for ellipses in YAML code blocks.
- IP/MAC Address Compliance: Checks example addresses against RFC standards.
- Code Block Quality: Assesses accuracy, copy-paste friendliness, and correct syntax highlighting tags.
- Use Case: Review a newly written procedure for configuring a service to ensure all commands requiring root privileges are correctly formatted and that example IP addresses are within the reserved ranges.
Quick Start
Review the changed files for SSG technical example compliance.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: rh-ssg-technical-examples Download link: https://github.com/redhat-documentation/redhat-docs-agent-tools/archive/main.zip#rh-ssg-technical-examples Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.