chore: Updated documentation

docs/data-sources/a_record.md

@@ -13,16 +13,12 @@ A record data source
 ## Example Usage
 
 ```terraform
-data "octodns_a_record" "default_scope" {
-  zone = "example.com"
+data "octodns_a_record" "root" {
+  zone = "unit.tests"
   name = "@"
 }
-
-
-data "octodns_a_record" "custom_scope" {
-  zone  = "example.com"
-  scope = "internal"
-  name  = "www"
+output "a_record" {
+  value = data.octodns_a_record.root
 }
 ```
 

docs/data-sources/aaaa_record.md

@@ -10,7 +10,17 @@ description: |-
 
 AAAA record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_aaaa_record" "aaaa" {
+  zone = "unit.tests"
+  name = "aaaa"
+}
+output "aaaa_record" {
+  value = data.octodns_aaaa_record.aaaa
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/caa_record.md

@@ -10,7 +10,17 @@ description: |-
 
 CAA record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_caa_record" "root" {
+  zone = "unit.tests"
+  name = "@"
+}
+output "caa_record" {
+  value = data.octodns_caa_record.root
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/cname_record.md

@@ -10,7 +10,17 @@ description: |-
 
 CNAME record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_cname_record" "cname" {
+  zone = "unit.tests"
+  name = "cname"
+}
+output "cname_record" {
+  value = data.octodns_cname_record.cname
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/dname_record.md

@@ -10,7 +10,17 @@ description: |-
 
 DNAME record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_dname_record" "dname" {
+  zone = "unit.tests"
+  name = "dname"
+}
+output "dname_record" {
+  value = data.octodns_dname_record.dname
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/loc_record.md

@@ -10,7 +10,17 @@ description: |-
 
 LOC record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_loc_record" "loc" {
+  zone = "unit.tests"
+  name = "loc"
+}
+output "loc_record" {
+  value = data.octodns_loc_record.loc
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/mx_record.md

@@ -10,7 +10,17 @@ description: |-
 
 MX record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_mx_record" "mx" {
+  zone = "unit.tests"
+  name = "mx"
+}
+output "mx_record" {
+  value = data.octodns_mx_record.mx
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/naptr_record.md

@@ -10,7 +10,17 @@ description: |-
 
 NAPTR record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_naptr_record" "naptr" {
+  zone = "unit.tests"
+  name = "naptr"
+}
+output "naptr_record" {
+  value = data.octodns_naptr_record.naptr
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/ns_record.md

@@ -10,7 +10,17 @@ description: |-
 
 NS record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_ns_record" "root" {
+  zone = "unit.tests"
+  name = "@"
+}
+output "ns_record" {
+  value = data.octodns_ns_record.root
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/srv_record.md

@@ -10,7 +10,17 @@ description: |-
 
 SRV record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_srv_record" "root" {
+  zone = "unit.tests"
+  name = "_imap._tcp"
+}
+output "srv_record" {
+  value = data.octodns_srv_record.root
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/sshfp_record.md

@@ -10,7 +10,17 @@ description: |-
 
 SSHFP record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_sshfp_record" "root" {
+  zone = "unit.tests"
+  name = "@"
+}
+output "sshfp_record" {
+  value = data.octodns_sshfp_record.root
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/txt_record.md

@@ -10,7 +10,17 @@ description: |-
 
 TXT record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_txt_record" "txt" {
+  zone = "unit.tests"
+  name = "txt"
+}
+output "txt_record" {
+  value = data.octodns_txt_record.txt
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/urlfwd_record.md

@@ -10,7 +10,17 @@ description: |-
 
 URLFWD record data source
 
-
+## Example Usage
+
+```terraform
+data "octodns_urlfwd_record" "urlfwd" {
+  zone = "unit.tests"
+  name = "urlfwd"
+}
+output "urlfwd_record" {
+  value = data.octodns_urlfwd_record.urlfwd
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/a_record.md

@@ -13,22 +13,11 @@ A record resource
 ## Example Usage
 
 ```terraform
-resource "octodns_a_record" "localhost" {
+resource "octodns_a_record" "root" {
   zone   = "example.com"
-  name   = "localhost"
-  ttl    = 3600
-  values = ["127.0.0.1"]
-  octodns = {
-    cloudflare = {
-      proxied = true
-    }
-  }
-}
-
-resource "octodns_a_record" "minimal" {
-  zone   = "example.com"
-  name   = "www"
-  values = ["127.0.0.1"]
+  name   = "@"
+  ttl    = 300
+  values = ["1.2.3.4", "5.6.7.8"]
 }
 ```
 
@@ -38,13 +27,13 @@ resource "octodns_a_record" "minimal" {
 ### Required
 
 - `name` (String) Record name. eq: <name>.example.com
-- `scope` (String) Scope of zone
 - `values` (List of String)
 - `zone` (String) Zone of the record. eq: example.com
 
 ### Optional
 
 - `octodns` (Attributes) Additional octodns config for the records (see [below for nested schema](#nestedatt--octodns))
+- `scope` (String) Scope of zone
 - `ttl` (Number) TTL of the record, leave empty for zone of server defaults
 
 ### Read-Only

docs/resources/aaaa_record.md

@@ -10,21 +10,29 @@ description: |-
 
 AAAA record resource
 
+## Example Usage
 
+```terraform
+resource "octodns_aaaa_record" "aaaa" {
+  zone   = "example.com"
+  name   = "aaaa"
+  values = ["2601:644:500:e210:62f8:1dff:feb8:947a"]
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
 - `name` (String) Record name. eq: <name>.example.com
-- `scope` (String) Scope of zone
 - `values` (List of String)
 - `zone` (String) Zone of the record. eq: example.com
 
 ### Optional
 
 - `octodns` (Attributes) Additional octodns config for the records (see [below for nested schema](#nestedatt--octodns))
+- `scope` (String) Scope of zone
 - `ttl` (Number) TTL of the record, leave empty for zone of server defaults
 
 ### Read-Only

docs/resources/caa_record.md

@@ -10,21 +10,40 @@ description: |-
 
 CAA record resource
 
+## Example Usage
 
+```terraform
+locals {
+
+  caa_raw = [
+    { flags = 30, tag = "issue", value = "ca.unit.tests" },
+  ]
+
+  caa_values = [for v in local.caa_raw : "${v.flags} ${v.tag} ${v.value}"]
+
+}
+
+resource "octodns_caa_record" "root" {
+  zone   = "example.com"
+  name   = "@"
+  ttl    = 300
+  values = local.caa_values
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
 - `name` (String) Record name. eq: <name>.example.com
-- `scope` (String) Scope of zone
 - `values` (List of String)
 - `zone` (String) Zone of the record. eq: example.com
 
 ### Optional
 
 - `octodns` (Attributes) Additional octodns config for the records (see [below for nested schema](#nestedatt--octodns))
+- `scope` (String) Scope of zone
 - `ttl` (Number) TTL of the record, leave empty for zone of server defaults
 
 ### Read-Only

docs/resources/cname_record.md

@@ -10,21 +10,29 @@ description: |-
 
 CNAME record resource
 
+## Example Usage
 
+```terraform
+resource "octodns_cname_record" "cname" {
+  zone   = "example.com"
+  name   = "cname"
+  values = ["unit.tests."]
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
 - `name` (String) Record name. eq: <name>.example.com
-- `scope` (String) Scope of zone
 - `values` (List of String)
 - `zone` (String) Zone of the record. eq: example.com
 
 ### Optional
 
 - `octodns` (Attributes) Additional octodns config for the records (see [below for nested schema](#nestedatt--octodns))
+- `scope` (String) Scope of zone
 - `ttl` (Number) TTL of the record, leave empty for zone of server defaults
 
 ### Read-Only