feat: init

docs/functions/example.md

@@ -1,6 +1,6 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "example function - scaffolding"
+page_title: "example function - assert"
 subcategory: ""
 description: |-
   Example function

docs/index.md

@@ -1,26 +1,35 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding Provider"
-subcategory: ""
+page_title: "Provider: Assert"
 description: |-
-  
+  The Assert provider provides functions to verify values in your Terraform configuration to make sure they meet specific criteria.
 ---
 
-# scaffolding Provider
+# ASSERT Provider
 
+The Assert provider is a utility provider that helps practitioners 
+to simplify the way they write assertions in their Terraform configuration.
 
+This provider does not manage any infrastructure, but instead provides a set of provider-defined functions
+that can be used to assert that values in Terraform configuration meet specific criteria.
+
+Use the navigation to the left to read about the available resources.
 
 ## Example Usage
 
+As of Terraform 1.8 and later, providers can implement functions that you can call from the Terraform configuration. 
+
+Define the provider as a `required_provider` to use its functions
+
 ```terraform
-provider "scaffolding" {
-  # example configuration here
+terraform {
+  required_providers {
+    assert = {
+      source  = "bschaatsbergen/assert"
+      version = ">= 1.0.0"
+    }
+  }
 }
 ```
 
-<!-- schema generated by tfplugindocs -->
-## Schema
-
-### Optional
+## Limitations
 
-- `endpoint` (String) Example provider attribute

examples/provider/provider.tf

@@ -1,3 +1,8 @@
-provider "scaffolding" {
-  # example configuration here
-}
+terraform {
+  required_providers {
+    assert = {
+      source  = "bschaatsbergen/assert"
+      version = ">= 1.0.0"
+    }
+  }
+}

go.mod

@@ -1,4 +1,4 @@
-module github.com/hashicorp/terraform-provider-scaffolding-framework
+module github.com/bschaatsbergen/terraform-provider-assert
 
 go 1.21
 
@@ -7,7 +7,6 @@ require (
 	github.com/hashicorp/terraform-plugin-docs v0.18.0
 	github.com/hashicorp/terraform-plugin-framework v1.6.1
 	github.com/hashicorp/terraform-plugin-go v0.22.1
-	github.com/hashicorp/terraform-plugin-log v0.9.0
 	github.com/hashicorp/terraform-plugin-testing v1.7.0
 )
 
@@ -40,6 +39,7 @@ require (
 	github.com/hashicorp/logutils v1.0.0 // indirect
 	github.com/hashicorp/terraform-exec v0.20.0 // indirect
 	github.com/hashicorp/terraform-json v0.21.0 // indirect
+	github.com/hashicorp/terraform-plugin-log v0.9.0 // indirect
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.33.0 // indirect
 	github.com/hashicorp/terraform-registry-address v0.2.3 // indirect
 	github.com/hashicorp/terraform-svchost v0.1.1 // indirect

internal/provider/example_function_test.go

@@ -22,7 +22,7 @@ func TestExampleFunction_Known(t *testing.T) {
 			{
 				Config: `
 				output "test" {
-					value = provider::scaffolding::example("testvalue")
+					value = provider::assert::example("testvalue")
 				}
 				`,
 				Check: resource.ComposeAggregateTestCheckFunc(
@@ -43,7 +43,7 @@ func TestExampleFunction_Null(t *testing.T) {
 			{
 				Config: `
 				output "test" {
-					value = provider::scaffolding::example(null)
+					value = provider::assert::example(null)
 				}
 				`,
 				// The parameter does not enable AllowNullValue
@@ -67,7 +67,7 @@ func TestExampleFunction_Unknown(t *testing.T) {
 				}
 				
 				output "test" {
-					value = provider::scaffolding::example(terraform_data.test.output)
+					value = provider::assert::example(terraform_data.test.output)
 				}
 				`,
 				Check: resource.ComposeAggregateTestCheckFunc(