Skills
.Work. You
Rest

check-code-examples

Official

Clarify and validate code examples.

Content & Communication#documentation#validation#Terraform#code-examples#summaries#Packer
Authorhashicorp
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill addresses the common issue of inconsistent or vague code examples in documentation. It enforces summaries, completeness, realistic values, and adherence to WAF (Well-Architected Framework) patterns for Terraform, Packer, and related tools to improve learning and implementation accuracy.

Core Features & Use Cases

  • Enforces code block summaries: ensures each code block is prefixed with a 1-2 sentence description of purpose.
  • Checks for completeness: validates required elements (e.g., provisioners, data sources, backends) exist and are realistic.
  • Promotes realistic values: discourages hard-coded placeholders and encourages data-driven configurations.
  • Supports review workflows: integrates with CI or documentation review to flag issues for manual fixes.
  • Real-world use case: when a doc includes a Terraform example, this skill verifies you can reference the data source and show backend configuration.

Quick Start

Use the /check-code-examples command to scan a file, e.g. /check-code-examples docs/deploy.mdx, and optionally run with --fix to auto-add basic summaries.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: check-code-examples
Download link: https://github.com/hashicorp/web-unified-docs/archive/main.zip#check-code-examples

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.