INFRASTRUCTURE / hashicorp
Terraform Provider Documentation
Generate Registry documentation from implemented schema descriptions, focused templates and reusable HCL examples.
“Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. …”
01 / THE REASONING
Why this made the selection.
- It generates Terraform Registry docs from schema descriptions and tfplugindocs templates, and it forbids pages for objects the provider does not implement.
- Examples stay one file each under examples/ and must not include terraform, provider, or output blocks.
- Maps individual provider object types to documentation targets, including ephemeral resources and actions.
- Connects schema changes, generated output validation and publication metadata checks.
02 / THE REVIEW RECORD
What we actually inspected.
Source review has boundaries.
A clear record is more useful than a “safe” badge.
Material inspected
- plugins/terraform/skills/provider-docs/SKILL.md
- plugins/terraform/skills/provider-docs/references/hashicorp-provider-docs.md
- README.md
- LICENSE
Our findings
- Templates are created only for implemented objects, then regenerated with tfplugindocs or go generate.
- The generator is fetched with go run github.com/hashicorp/terraform-plugin-docs when the repo has no generate target.
- The quality bar says never to describe unsupported arguments or attributes.
- Examples must not contain terraform, provider, or output blocks.
- Reference distinguishes provider-index examples from resource/data-source/action examples.
- Action documentation must show action declaration and resource-side trigger wiring, with no generated attribute/output section.
- The template workflow keeps examples in separate files referenced through tffile and excludes terraform, provider and output blocks from those examples.
Not established by this review
- The resource was not executed and its tools were not called.
- No skill execution, authenticated service operation, or outcome benchmark was performed.
- Not executed: it was not installed or run.
The review applies to the material and revision named here. A newer upstream release can change its behavior.
03 / PUT IT TO WORK
Add a skill to your workflow.
DOCUMENTED COMMAND
npx skills add hashicorp/agent-skills/plugins/terraform/skills/provider-docs Run in your terminal to choose your AI tools, project or global scope, and installation method. This short command follows the current upstream version; the review covers the revision shown above.
Optional: install the reviewed revision
Keeps the original source and installer version where recorded, while leaving your AI tools and installation scope for you to choose.
npx skills add https://github.com/hashicorp/agent-skills/tree/f706481af9b8fedb66de909f6243ad29601afa0c/plugins/terraform/skills/provider-docs - Install the pinned skill directory interactively, retaining its bundled references and scripts.
- Map changed provider objects to their schema descriptions and templates.
- Generate using repository defaults, inspect output against schema and validate release tags/manifest before publication.
Before you start
- Provider source, Go tooling and configured tfplugindocs
- Terraform version compatible with the documented object type
04 / FOLLOW THE EVIDENCE
The source trail.
Our notes are separate from the original resource.
Check upstream before adopting a new version.
- Pinned skill definition ↗Checked
https://github.com/hashicorp/agent-skills/blob/f706481af9b8fedb66de909f6243ad29601afa0c/plugins/terraform/skills/provider-docs/SKILL.md
Supports: summary, whySelected, bestFor, limitations, install, access, review
https://github.com/hashicorp/agent-skills/blob/f706481af9b8fedb66de909f6243ad29601afa0c/README.md
Supports: install
- MPL-2.0 licence ↗Checked
https://github.com/hashicorp/agent-skills/blob/f706481af9b8fedb66de909f6243ad29601afa0c/LICENSE
Supports: license
https://github.com/hashicorp/agent-skills/blob/f706481af9b8fedb66de909f6243ad29601afa0c/plugins/terraform/skills/provider-docs/references/hashicorp-provider-docs.md
Supports: review, limitations, access, install
https://raw.githubusercontent.com/hashicorp/agent-skills/f706481af9b8fedb66de909f6243ad29601afa0c/plugins/terraform/skills/provider-docs/SKILL.md
Supports: review.findings, bestFor, upstreamDescription