provider-docs

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.