Document nested objects immediately below the fields they correspond to

[danawillow]

Right now we usually say "structure is documented below", requiring the user to find the correct place later in the page to get the list of nested fields. Instead of that, we should just put them immediately below the parent field.

[danawillow]

After some offline discussion, this is going to be a much larger effort than just nesting fields underneath. Once an object has more than a few fields in it, it's really hard to tell where you are (Google_ google_cloud_run_service - Terraform by HashiCorp.pdf), which I think will end up being a worse UX overall. Sounds like there's some thinking around this being done on the HahsiCorp side, so tabling for now.

[rileykarson]

Note: Anchor links for fields with duplicate names cause issues today, this might? address this if we override the anchors' default names.

We want to address this somehow, but probably in a larger proposal of some form.

[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.