I’m developing a Terraform provider using the Terraform Plugin Framework and generating docs with terraform-plugin-docs.
The documents generate correctly, but I’m trying to avoid manually duplicating schema information. Is there a way for terraform-plugin-docs to automatically include schema metadata such as:
-
Default values for attributes
-
Whether an attribute change causes resource replacement (
RequiresReplace/ForceNew)
These properties are defined in the schema but don’t appear in the generated documentation by default.
Is there a configuration/extension mechanism I’m missing? If it’s not supported, is it the best practice to document these behaviours explicitly in the attribute description?