check-code-examples

Validating Terraform code examples involves checking MDX files for summaries, completeness, and realistic values. This skill scans your documentation to enforce quality criteria and Well-Architected Framework patterns for embedded snippets.

Adding summaries to code blocks in MDX files can be automated using a --fix command option. This auto-inserts basic 1-2 sentence descriptions of the code's purpose, while leaving deeper structural edits to human reviewers.

Yes, this documentation checker works with Packer configurations alongside Terraform and related tooling. It reviews embedded Packer demonstrations to verify required elements and discourage hard-coded placeholders.

Enforcing Well-Architected Framework patterns in documentation requires verifying that code examples use data-driven configurations and realistic values. This skill flags snippets missing provisioners or backends for manual correction.

Yes, you can integrate code example validation into CI or documentation review workflows. By passing file-path arguments to the scanner, it automatically flags incomplete snippets and missing summaries for manual fixes during the review process.

The limitation of auto-fixing documentation code blocks is that the --fix option only inserts basic summaries. It does not perform deeper edits or resolve complex structural issues, leaving those manual corrections to human reviewers.