test-docs

Execute documented instructions against real environments and report verification results.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires kubectl, helm, kind, thv, jq, curl, and includes scripts (resource) components.

What problem does it solve?

This Skill helps prevent inaccurate or outdated documentation by running ToolHive documentation instructions in a real environment and identifying broken examples before users encounter them.

Core Features & Use Cases

  • Documentation Validation: Executes tutorials, guides, and CLI or Kubernetes workflows to verify that documented steps work as expected.
  • Test Planning and Reporting: Extracts commands, manifests, and expected results, then produces pass/fail evidence with failure classifications and recommendations.
  • Use Case: A documentation maintainer can use this Skill to test a Vault integration tutorial against a live Kubernetes environment and identify whether failures come from documentation errors, ToolHive bugs, or environment issues.

Quick Start

Use the test-docs skill to verify the ToolHive vault integration tutorial and report whether every documented step passes.

Frequently Asked Questions about test-docs

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

FAQPage Schema
How do I validate documentation workflows against a real Kubernetes environment?

You can validate documentation by executing documented instructions against a live Kubernetes environment, tracking sequential execution, and classifying failures with evidence-based reports to confirm whether tutorials work as expected.

What is documentation testing and how does it prevent broken CLI tutorials?

Documentation testing prevents broken CLI tutorials by running documented commands against real environments, extracting expected results, and reporting verification failures to maintainers before users encounter outdated or inaccurate instructions.

Do I need kubectl and helm installed to test ToolHive integration tutorials?

Yes, you need kubectl, helm, kind, thv, jq, and curl installed to perform deterministic prerequisite checks and execute documented instructions against a live environment for ToolHive tutorials.

How do I identify whether a Vault integration tutorial failure is a documentation error or environment issue?

You can identify failure sources by executing documented steps against a real environment and applying evidence-based failure classification to distinguish documentation errors from ToolHive bugs or environment issues.

Can I use this approach to verify CLI guides and Kubernetes manifests automatically?

Yes, you can verify CLI guides and Kubernetes manifests by extracting commands and manifests from documentation, executing them sequentially, and generating test reports with pass or fail evidence and recommendations.

What's the best way to test automation scripts for technical documentation accuracy?

The best way to test documentation accuracy is running documented instructions against real environments with deterministic prerequisite checks, sequential execution tracking, and evidence-based failure classification to identify broken examples.