test-docs-dryrun

Validate documentation YAML examples against Kubernetes CRD schemas.

4|3|Updated Jun 5, 2025
One-click install
npx skills add https://github.com/stacklok/docs-website --skill test-docs-dryrun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: test-docs-dryrun
Source: https://github.com/stacklok/docs-website/tree/main/.claude/skills/test-docs-dryrun
Command: npx skills add https://github.com/stacklok/docs-website --skill test-docs-dryrun

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires kubectl, python3, and includes scripts (resource) components.

What problem does it solve?

This Skill prevents documentation drift by automatically detecting invalid ToolHive Kubernetes resource examples before they reach users.

Core Features & Use Cases

  • CRD Schema Validation: Extracts ToolHive YAML examples from documentation and validates them against installed Kubernetes CRDs using server-side dry runs.
  • Documentation Quality Checks: Identifies field name errors, type mismatches, and API schema changes across Kubernetes Operator and Virtual MCP Server guides.
  • Use Case: Use this Skill after a CRD or API update to quickly verify that all documentation examples remain compatible with the current schemas.

Quick Start

Run the docs dry-run validation skill to check all ToolHive documentation YAML examples for schema issues.

Frequently Asked Questions about test-docs-dryrun

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate Kubernetes YAML examples against CRD schemas in documentation?

Validating Kubernetes YAML examples against CRD schemas involves extracting YAML code blocks from MDX documentation files and performing server-side dry runs using kubectl. This process detects field name errors, type mismatches, and API schema changes before release.

What is documentation dry run testing for Kubernetes Operator guides?

Documentation dry run testing for Kubernetes Operator guides is an automated validation process that checks ToolHive YAML examples against installed Custom Resource Definitions. It prevents documentation drift by catching invalid configuration examples after CRD or API schema updates.

Do I need a Kubernetes cluster to test YAML documentation examples?

Yes, you need a running Kubernetes cluster with ToolHive CRDs installed to test YAML documentation examples. The server-side dry run validation requires kubectl to communicate with the cluster and verify configurations against active schemas.

Can I use Python to extract YAML blocks from MDX files for kubectl validation?

Yes, Python is used to extract YAML blocks from MDX files for kubectl validation. The Skill leverages Python scripts to parse documentation and isolate YAML examples, which are then validated against Kubernetes CRD schemas via server-side dry runs.

Why does my ToolHive documentation YAML fail CRD validation after an API update?

ToolHive documentation YAML fails CRD validation after an API update when schema changes introduce new required fields, alter types, or rename properties. Running documentation dry-run validation identifies these mismatches so you can update the examples accordingly.