schemadoc

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 19, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DisplayFamilyTitle added in v0.2.1

func DisplayFamilyTitle(family string, preferred string) string

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 RenderStepKindsPage(inputs []PageInput) []byte

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

func StepKindSlug(kind string) string

func ToolKinds

func ToolKinds() ([]string, error)

Types

type Field

type Field = schemafacts.FieldFact

type FieldDoc

type FieldDoc struct {
	Description string
	Example     string
}

type GroupFlow added in v0.2.2

type GroupFlow struct {
	Title string
	Kinds []string
	Note  string
}

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 PageInput

type PageInput struct {
	Group        string
	PageSlug     string
	Title        string
	Summary      string
	Description  string
	WhenToUse    string
	TypicalFlows []GroupFlow
	SeeAlso      []string
	Variants     []VariantInput
}

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 PageOverrides struct {
	FieldDocs map[string]FieldDoc
	Example   string
	Notes     []string
}

type PhaseInput added in v0.2.9

type PhaseInput struct {
	Key         string
	Title       string
	Description string
}

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
}

type VariantInput

type VariantInput struct {
	Kind        string
	Title       string
	Description string
	Schema      map[string]any
	Meta        ToolMetadata
	Required    []string
	Spec        map[string]any
	Outputs     []string
	Roles       []string
	GroupOrder  int
	DocsOrder   int
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL