Add documentation about how to document a resource / attribute #1502
Description
Product
Terraform
Issue type
New content
Describe your issue to request changes to the content on developer.hashicorp.com. Be specific and provide as much detail as possible. Include page URLs and screenshots if applicable.
In the documentation for terraform, it would be really helpful to show case that the description of a resource or data source could be used in combination with the terraform language server to have immersive documentation experience https://github.com/hashicorp/terraform-ls
Basically if my description are filled, I can have extra documentation popping up in my editor.
It would be helpful to show case examples for that, in particular it would be helpful to show case how complex documentation could be embedded inside a provider
I got an example here: https://github.com/scaleway/terraform-provider-scaleway/pull/3526/changes but you can adapt it to a more general context with hashicups