specs

type Context struct {
	// Requires is the list of requirements for the task.
	Requires []string `json:"requires,omitempty" yaml:"requires,omitempty"`
	// Instruction is the instruction for the task.
	Instruction string `json:"instruction" yaml:"instruction"`
	// TrackBy is the list of fields to track by.
	TrackBy []string `json:"trackBy,omitempty" yaml:"trackBy,omitempty"`
	// Documents is the list of documents for the task.
	Documents Documents `json:"documents" yaml:"documents"`
}

type Document struct {
	// ID identifies a document in the specification.
	ID string `json:"id" yaml:"id"`
	// Generates the document from the task's output.
	Generates string `json:"generates" yaml:"generates"`
	// Description is the description of the document.
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	// Instruction is the instruction for generating the document.
	Instruction string `json:"instruction" yaml:"instruction"`
	// Template is the basis for the document.
	Template string `json:"template" yaml:"template"`
}

type Documents []Document

type Model struct {
	// RequestOptions are the request options for the model.
	RequestOptions map[string]any `json:"requestOptions,omitempty" yaml:"requestOptions,omitempty"`
	// ID is the unique identifier for the model.
	ID string `json:"id" yaml:"id"`
	// Name is the name of the model.
	Name string `json:"name" yaml:"name"`
	// URL is the URL of the model.
	URL string `json:"url" yaml:"url"`
	// Provider is the provider of the model.
	Provider Provider `json:"provider" yaml:"provider"`
	// Roles are the roles of the model.
	Roles []string `json:"roles" yaml:"roles"`
}

type Provider string

type Rule string

type Rules map[string][]Rule

type Sites struct {
	// Name is the name of the site.
	Name string `json:"name" yaml:"name"`
	// Path is the path to the deployment configuration file.
	Path string `json:"path" yaml:"path"`
	// Site is the name of the site to deploy to.
	Site string `json:"site" yaml:"site"`
	// Ignore is a list of files to ignore during deployment.
	Ignore []string `json:"ignore" yaml:"ignore"`
}

type Spec struct {
	// Version is the version of the spec.
	Version int `json:"version" yaml:"version"`
	// Name is the name of the spec.
	Name string `json:"name,omitempty" yaml:"name"`
	// Root is the root directory of the spec.
	Root string `json:"root,omitempty" yaml:"root,omitempty"`
	// Description is the description of the spec.
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	// Rules define the rules for the spec.
	Rules Rules `json:"rules" yaml:"rules"`
	// Constitution is the constitution of the spec.
	Constitution string `json:"constitution" yaml:"constitution"`
	// Models define the models for the spec.
	Models []Model `json:"models,omitempty" yaml:"models,omitempty"`
	// Sites defines the deployment configuration for the specification.
	Sites *Sites `json:"sites,omitempty" yaml:"sites,omitempty"`
	// Tasks define the tasks for the spec.
	Tasks Tasks `json:"tasks" yaml:"tasks"`
}

type Task struct {
	// ID is the ID of the task.
	ID string `json:"id" yaml:"id"`
	// Name is the name of the task.
	Name string `json:"name" yaml:"name"`
	// Description is the description of the task.
	Description string `json:"description" yaml:"description"`
	// Context is the context for the task.
	Context Context `json:"context" yaml:"context"`
}

type Tasks map[string]Task