Documentation
¶
Overview ¶
Package help exposes exact embedded help assets through the application layer.
Index ¶
Constants ¶
View Source
const ( // TopicQuickstart is the entry-point help topic. TopicQuickstart = "quickstart" // TopicConfig documents configuration. TopicConfig = "config" // TopicProviders documents provider setup and readiness. TopicProviders = "providers" // TopicRolePaths documents provider execution paths. TopicRolePaths = "role-paths" // TopicPrompts documents prompt contracts. TopicPrompts = "prompts" // TopicWorkflows documents CLI workflows. TopicWorkflows = "workflows" // TopicArtifacts documents artifact storage and lineage. TopicArtifacts = "artifacts" // TopicValidation documents output validation. TopicValidation = "validation" // TopicCI documents CI reporting. TopicCI = "ci" // TopicExitCodes documents process exit codes. TopicExitCodes = "exit-codes" // TopicSecurity documents security and trust boundaries. TopicSecurity = "security" )
Variables ¶
View Source
var ( // ErrNilCatalog reports construction or use without a ContractCatalog. ErrNilCatalog = errors.New("help: nil contract catalog") // ErrNilContext reports an invalid nil context. ErrNilContext = errors.New("help: nil context") // ErrEmptyTopic reports an empty help topic. ErrEmptyTopic = errors.New("help: empty topic") // ErrUnsafeTopic reports a topic that is not a canonical topic token. ErrUnsafeTopic = errors.New("help: unsafe topic") // ErrUnknownTopic reports a canonical but unsupported help topic. ErrUnknownTopic = errors.New("help: unknown topic") // ErrCatalogIncomplete reports a missing, duplicate, or unexpected help asset. ErrCatalogIncomplete = errors.New("help: incomplete contract catalog") // ErrCatalogInconsistent reports a Read result that differs from its listed asset. ErrCatalogInconsistent = errors.New("help: inconsistent contract catalog") )
Functions ¶
This section is empty.
Types ¶
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service lists and renders the fixed help surface from a ContractCatalog.
func NewService ¶
func NewService(catalog ports.ContractCatalog) (*Service, error)
NewService constructs a help service over catalog. Catalog completeness is checked for each Topics and Render operation with the caller's context.
Source Files
Click to show internal directories.
Click to hide internal directories.