Documentation
¶
Overview ¶
Package concepts provides a registry of scafctl domain concepts with concise explanations, examples, and cross-references. It is used by MCP tools, CLI help, and documentation generation.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Categories ¶
func Categories() []string
Categories returns a sorted list of unique category names.
Types ¶
type Concept ¶
type Concept struct {
// Name is the canonical kebab-case concept identifier.
Name string `json:"name" yaml:"name"`
// Title is the human-readable display name.
Title string `json:"title" yaml:"title"`
// Category groups related concepts (e.g., "resolvers", "testing", "actions").
Category string `json:"category" yaml:"category"`
// Summary is a one-sentence description.
Summary string `json:"summary" yaml:"summary"`
// Explanation is a multi-paragraph detailed explanation.
Explanation string `json:"explanation" yaml:"explanation"`
// Examples provides short YAML or code examples.
Examples []string `json:"examples,omitempty" yaml:"examples,omitempty"`
// SeeAlso lists related concept names.
SeeAlso []string `json:"seeAlso,omitempty" yaml:"seeAlso,omitempty"`
}
Concept describes a single scafctl domain concept.
func ByCategory ¶
ByCategory returns all concepts in a given category, sorted by name.
Click to show internal directories.
Click to hide internal directories.