skills.rest
kk0ga
kk0gaCOMMUNITY
Explore all skills by this author →
Website𝕏@_kkogaGitHub

provider-docs

Generate and validate Terraform Registry provider documentation using tfplugindocs.

Updated Jul 20, 2026
Search Tags:#automation#documentation#registry#terraform#hashicorp#provider
One-click install
npx skills add https://github.com/kk0ga/terraform-aws-learning --skill provider-docs-kk0ga
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: provider-docs
Source: https://github.com/kk0ga/terraform-aws-learning/tree/main/.agents/skills/provider-docs
Command: npx skills add https://github.com/kk0ga/terraform-aws-learning --skill provider-docs-kk0ga

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of maintaining accurate, HashiCorp-compliant documentation for Terraform providers, ensuring that Registry-facing content remains synchronized with schema definitions and implementation details.

Core Features & Use Cases

  • Automated Generation: Uses tfplugindocs to generate documentation directly from provider schema descriptions and templates.
  • Registry Compliance: Enforces HashiCorp-recommended directory structures and manifest requirements for successful Terraform Registry publication.
  • Use Case: When adding a new resource to a Terraform provider, use this Skill to generate the corresponding documentation template and validate that the schema descriptions are correctly rendered for end-users.

Quick Start

Use the provider-docs skill to generate the latest documentation for the current provider implementation by running the go generate command from the repository root.

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 HashiCorp Registry?▼

Terraform provider documentation can be generated by running the go generate command from the repository root, which uses tfplugindocs to create markdown templates directly from your provider schema descriptions.

What is the standard way to maintain resource and data source docs in a Terraform provider?▼

Maintaining Terraform provider docs involves generating markdown directly from schema descriptions and templates, ensuring resource, data source, and guide documentation stays synchronized with the provider implementation details for Registry publication.

Do I need tfplugindocs to standardize my HashiCorp registry documentation?▼

Yes, tfplugindocs is required to standardize and generate HashiCorp registry documentation, as it automates rendering markdown templates directly from provider schema descriptions and validates directory structure compliance.

Can I validate my Terraform provider's directory structure before publishing to the Registry?▼

You can validate your Terraform provider's directory structure using this Skill, which enforces HashiCorp-recommended manifest requirements and directory layouts to ensure successful Terraform Registry publication.

How do I update Terraform provider docs when adding a new resource?▼

When adding a new resource to a Terraform provider, use this Skill to generate the corresponding documentation template and validate that the schema descriptions are correctly rendered for end-users.

Related Skills

Explore More Software Engineering Skills→
hashi-demo-labhashi-demo-lab

provider-docs

Generate Terraform Registry documentation from provider schemas and markdown templates.

Official
Advanced
robinmordasiewiczrobinmordasiewicz
2

terraform-registry-inspector

Inspects Terraform Registry provider documentation for rendering quality and link validity.

Community
Intermediate
hashicorphashicorp
790

new-terraform-provider

Scaffold a Terraform provider workspace with the Plugin Framework.

Official
Advanced
foeriafoeria

格式转换助手

Convert Markdown files into Word-ready documents with preserved structure.

Community
Basic