Unclear message about what makes a bad schema

[remyleone]

Terraform CLI and terraform-plugin-docs Versions

github.com/hashicorp/terraform-plugin-docs v0.22.0 // indirect

❯ terraform version
Terraform v1.12.2
on darwin_arm64

Provider Code

"public_network": {
				Type:        schema.TypeList,
				Optional:    true,
				Computed:    true,
				MaxItems:    1,
				Description: "Public network specs details",
				Elem: &schema.Resource{
					Schema: map[string]*schema.Schema{
						"id": {
							Type:        schema.TypeString,
							Computed:    true,
							Description: "ID of the public network",
						},
						"port": {
							Type:        schema.TypeInt,
							Computed:    true,
							Description: "TCP port of the endpoint",
						},
						"dns_record": {
							Type:        schema.TypeString,
							Computed:    true,
							Description: "The DNS record of your endpoint",
						},
					},
				},
			},

Expected Behavior

I would expect helpful hints about how to correct my schema to fix the issue and being able to introduce terraform-docs into my workflow.

Actual Behavior

Error executing command: unable to generate website: error rendering static website: unable to render templated website to static markdown: unable to render resource template "resources/mongodb_instance.md.tmpl": unable to render schema: unable to render schema: no match for "public_network", this can happen if you have incompatible schema defined, for example an optional block where all the child attributes are computed, in which case the block itself should also be marked computed

Steps to Reproduce

Use the PR https://github.com/scaleway/terraform-provider-scaleway/pull/3270/files
Try to checkout the master branch of one of the changed file in the PR
go tool tfplugindocs generate

How much impact is this issue causing?

High

Logs

No response

Additional Information

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[remyleone]

I guess it was also true for Optional and not only computed. Is there any kind of linter that could be passed on schema to ensure that they are valid before running tfplugindocs ?