Documentation
¶
Index ¶
- func DisplayFamilyTitle(family string, preferred string) string
- func RenderComponentFragmentSchemaPartial(schemaPath string, schema map[string]any, meta PageMetadata) []byte
- func RenderStepKindPage(in StepKindPage) []byte
- func RenderStepKindsPage(inputs []PageInput) []byte
- func RenderSystemVariablesPartial() []byte
- func RenderToolDefinitionSchemaPartial(schemaPath string, schema map[string]any, meta PageMetadata) []byte
- func RenderWorkflowSchemaPartial(schemaPath string, schema map[string]any, meta PageMetadata) []byte
- func StepKindSlug(kind string) string
- func ToolKinds() ([]string, error)
- type Field
- type FieldDoc
- type GroupFlow
- type GroupMetadata
- type PageInput
- type PageMetadata
- type PageOverrides
- type PhaseInput
- type StepKindPage
- type ToolMetadata
- type VariantInput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DisplayFamilyTitle ¶ added in v0.2.1
func RenderComponentFragmentSchemaPartial ¶ added in v0.2.2
func RenderComponentFragmentSchemaPartial(schemaPath string, schema map[string]any, meta PageMetadata) []byte
func RenderStepKindPage ¶ added in v0.2.9
func RenderStepKindPage(in StepKindPage) []byte
func RenderStepKindsPage ¶ added in v0.2.9
func RenderSystemVariablesPartial ¶ added in v0.2.6
func RenderSystemVariablesPartial() []byte
func RenderToolDefinitionSchemaPartial ¶ added in v0.2.2
func RenderToolDefinitionSchemaPartial(schemaPath string, schema map[string]any, meta PageMetadata) []byte
func RenderWorkflowSchemaPartial ¶ added in v0.2.2
func RenderWorkflowSchemaPartial(schemaPath string, schema map[string]any, meta PageMetadata) []byte
func StepKindSlug ¶ added in v0.2.9
Types ¶
type Field ¶
type Field = schemafacts.FieldFact
type GroupMetadata ¶ added in v0.2.2
type GroupMetadata struct {
Key string
Title string
Aliases []string
Summary string
WhenToUse string
Order int
TypicalFlows []GroupFlow
SeeAlso []string
}
func GroupMeta ¶ added in v0.2.2
func GroupMeta(key string) (GroupMetadata, bool)
func GroupMetas ¶ added in v0.2.2
func GroupMetas() []GroupMetadata
func MustGroupMeta ¶ added in v0.2.2
func MustGroupMeta(key string) GroupMetadata
type PageMetadata ¶
type PageMetadata struct {
Title string
Summary string
Example string
FieldDocs map[string]FieldDoc
Notes []string
}
func ComponentFragmentMeta ¶
func ComponentFragmentMeta() PageMetadata
ComponentFragmentMeta intentionally stays centralized because component fragments are top-level authoring documents, not typed step kinds.
func ToolDefinitionMeta ¶
func ToolDefinitionMeta() PageMetadata
ToolDefinitionMeta intentionally stays centralized because it documents the tool-definition manifest format, not a workflow step kind.
func WorkflowMeta ¶
func WorkflowMeta() PageMetadata
WorkflowMeta intentionally stays centralized because it documents the top-level workflow document contract rather than a typed step registered through stepmeta.
type PageOverrides ¶
type PhaseInput ¶ added in v0.2.9
func StepKindPhases ¶ added in v0.2.9
func StepKindPhases() []PhaseInput
type StepKindPage ¶ added in v0.2.9
type StepKindPage struct {
Phase PhaseInput
Group PageInput
Variant VariantInput
}
func StepKindPages ¶ added in v0.2.9
func StepKindPages(inputs []PageInput) []StepKindPage
type ToolMetadata ¶
type ToolMetadata struct {
Kind string
Category string
Summary string
WhenToUse string
Example string
FieldDocs map[string]FieldDoc
Notes []string
}
func ToolMetaForDefinition ¶
func ToolMetaForDefinition(def workflowcontract.StepDefinition) ToolMetadata
Click to show internal directories.
Click to hide internal directories.