provider-docs

Generate Terraform Registry documentation from provider schemas and markdown templates.

Updated Mar 8, 2026
One-click install
npx skills add https://github.com/hashi-demo-lab/terraform-provider-aap --skill provider-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: provider-docs
Source: https://github.com/hashi-demo-lab/terraform-provider-aap/tree/main/.claude/skills/provider-docs
Command: npx skills add https://github.com/hashi-demo-lab/terraform-provider-aap --skill provider-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Standardizes and accelerates Terraform provider documentation for the Terraform Registry by enforcing HashiCorp-aligned patterns, templates, and validation steps.

Core Features & Use Cases

  • Write schema descriptions first to ensure docs reflect current provider behavior and constraints.
  • Add or update template files in docs/ using HashiCorp-recommended paths to map provider objects to registry docs.
  • Generate documentation with tfplugindocs (via go generate or direct tool) and validate against the current schema.
  • Preview, troubleshoot, and refine docs to ensure accuracy in the Terraform Registry.

Quick Start

Run go generate from the repository root to generate Terraform Registry documentation from the current provider schema and templates.

Frequently Asked Questions about provider-docs

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

FAQPage Schema
How do I generate Terraform provider documentation for the Terraform Registry?

To generate Terraform provider documentation, run `go generate` from the repository root to apply schema descriptions and docs/ markdown templates using tfplugindocs, producing Registry-ready output.

Why are my Terraform provider docs missing or incorrect on the Registry?

Missing or incorrect Terraform provider docs occur when template files in docs/ do not align with schema descriptions. Troubleshoot by validating generated docs against the current provider schema.

What is the best way to standardize Terraform provider documentation templates?

Standardizing Terraform provider documentation requires applying HashiCorp-aligned patterns and template paths in docs/ to map provider objects like resources and data sources to registry docs.

Do I need tfplugindocs to automate Terraform provider documentation creation?

Yes, automating Terraform provider documentation creation relies on tfplugindocs via `go generate` to process schema descriptions and markdown templates into validated Registry-ready documentation.

Can I use this workflow to document ephemeral resources and provider functions?

Yes, this workflow supports adding or changing documentation for ephemeral resources, list resources, functions, and guides by writing schema descriptions first and mapping them with docs/ templates.

What are the limitations of generating docs with tfplugindocs?

Generating docs with tfplugindocs relies on accurate schema descriptions and manually maintained markdown templates in docs/; if schemas lack descriptions or templates are misconfigured, the generated Registry output will be incomplete or inaccurate.