[chore] Add README documentation (#999)

smartcontractkit · Jan 16, 2025 · 5ef3235 · 5ef3235
1 parent e56b78c
commit 5ef3235
Show file tree

Hide file tree

Showing 4 changed files with 140 additions and 1 deletion.
diff --git a/pkg/workflows/sdk/builder.go b/pkg/workflows/sdk/builder.go
@@ -10,6 +10,7 @@ import (
 	"github.com/smartcontractkit/chainlink-common/pkg/capabilities"
 )
 
+// WorkflowSpecFactory is used to build WorkflowSpecs.
 type WorkflowSpecFactory struct {
 	spec           *WorkflowSpec
 	names          map[string]bool
@@ -125,6 +126,8 @@ func (c *capDefinitionImpl[O]) self() CapDefinition[O] {
 
 func (c *capDefinitionImpl[O]) private() {}
 
+// NewWorkflowSpecFactory initializes a WorkflowSpecFactory. This is usually the first function that is called
+// when writing a new workflow.
 func NewWorkflowSpecFactory() *WorkflowSpecFactory {
 	return &WorkflowSpecFactory{
 		spec: &WorkflowSpec{