Improve Framework Documentation

[bendbennett]

Module version

v1.0.0

Use-cases

Documentation for the following could be improved.

• Getting Started - Code Walkthrough - Terraform Configuration
• Handling Data - Terraform Concepts
• Handling Data - Terraform Concepts - Nested Blocks
• Handling Data - Terraform Concepts - Custom Types

Attempted Solutions

N/A

Proposal

• Getting Started - Code Walkthrough - Terraform Configuration - This may give the impression that the provider developer can just create a *.tf file with the below and it'll work. Need to add further clarification or point to other documentation to mention how to wire/publish things together fully.
• Handling Data - Terraform Concepts - Might make sense to summarize that attributes set values and provide a quick table of descriptions -- leaving the nitty gritty details for the attributes page.
• Handling Data - Terraform Concepts - Nested Blocks - Can just include a quick summary here similar to the top of the blocks page, then link to that page for the rest.
• Handling Data - Terraform Concepts - Custom Types - This is a framework-defined concept and not a Terraform one, move this to its own new page.

References

• Refactor Schema and Schema Data Related Documentation #554

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.