Terminal
Terminal/Skill
Guide for writing and checking Terraform Registry documentation for provider resources, data sources, and guides, using tfplugindocs.
By HashiCorp
Works with
npx skills add hashicorp/agent-skills --skill provider-docsdocs/.docs/index.md.tmpldocs/data-sources/<name>.md.tmpldocs/resources/<name>.md.tmpldocs/ephemeral-resources/<name>.md.tmpldocs/list-resources/<name>.md.tmpldocs/functions/<name>.md.tmpldocs/actions/<name>.md.tmpl (tfplugindocs generates action docs with Terraform v1.14.0+)docs/guides/<name>.md.tmplexamples/ directory — one example per file, pulled into templates with tffile — rather than inlined in templates (see Example File Conventions in references/hashicorp-provider-docs.md). Examples must not contain terraform, provider, or output blocks.references/hashicorp-provider-docs.md (Action Pages section): examples must show both the action block and the action_trigger lifecycle wiring, and actions get no attribute/output section.tfplugindocs.go generate ./...
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name <provider_name>
docs/ match the current provider implementation.v (for example v1.2.3).terraform-registry-manifest.json in the repository root.references/hashicorp-provider-docs.md for source-backed rules and official links.