tffwdocs

package main

import (
	"context"
	"log"

	tffwdocs "github.com/magodo/terraform-plugin-framework-docs"
	"github.com/magodo/terraform-plugin-framework-docs/internal/metadata"
	"github.com/magodo/terraform-plugin-framework-docs/internal/testprovider"
)

func main() {
	ctx := context.Background()
	gen, err := tffwdocs.NewGenerator(ctx, &testprovider.ExampleCloudProvider{})
	if err != nil {
		log.Fatal(err)
	}
	if err := gen.Lint(nil); err != nil {
		log.Fatal(err)
	}
	if err := gen.WriteAll(ctx, "./internal/testprovider/docs", &tffwdocs.RenderOptions{
		Provider: &metadata.ProviderRenderOption{
			Examples: []tffwdocs.Example{
				{
					Header:      "Basic",
					Description: "The basic configuration.",
					HCL: `
provider "examplecloud" {
	name = "foo"
}
	`,
				},
				{
					Header:      "Complete",
					Description: "The complete configuration.",
					HCL: `
provider "examplecloud" {
	name = "foo"
	address = "bar"
	age = 123
	role = "Software Engineer"
}
	`,
				},
			},
		},
		Resources: map[string]tffwdocs.ResourceRenderOption{
			"examplecloud_resource": metadata.ResourceRenderOption{
				Subcategory: "abc",
				Examples: []tffwdocs.Example{
					{
						Header:      "Basic",
						Description: "The basic configuration.",
						HCL: `
resource "examplecloud_resource" "example" {
	name = "foo"
}
`,
					},
					{
						Header:      "Complete",
						Description: "The complete configuration.",
						HCL: `
resource "examplecloud_resource" "example" {
	name = "foo"
	address = "bar"
	age = 123
	role = "Software Engineer"
}
`,
					},
				},
				ImportId: &tffwdocs.ImportId{
					Format:    "<parent_id>/<id>[/<version>]",
					ExampleId: "123/456",
					ExampleBlk: `
import {
	to = examplecloud_resource.example
	id = "123/456"
}
`,
				},
				IdentityExamples: []tffwdocs.Example{
					{
						Header:      "Without Version",
						Description: "Import without version.",
						HCL: `
import {
	to = examplecloud_resource.example
	identity = {
		parent_id = "123"
		id = "456"
	}
}
`,
					},
					{
						Header:      "With Version",
						Description: "Import with version.",
						HCL: `
import {
	to = examplecloud_resource.example
	identity = {
		parent_id = "123"
		id = "456"
		version = "v2"
	}
}
`,
					},
				},
			},
		},
	}); err != nil {
		log.Fatal(err)
	}
}

Output: