Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateCLIReference ¶
GenerateCLIReference walks the Cobra command tree and emits a complete CLI reference markdown document. Hidden commands are omitted.
func GenerateConfigReference ¶
func GenerateConfigReference() string
GenerateConfigReference emits a complete config reference markdown document. Fields are discovered via reflection on the config structs. The override maps provide curated descriptions, allowed values, defaults, and notes.
Types ¶
type FieldOverride ¶
type FieldOverride struct {
Description string
AllowedValues []string
Default string
Required *bool // override omitempty heuristic
Example string
Notes []string
}
FieldOverride provides per-field documentation enrichment.
type SectionOverride ¶
type SectionOverride struct {
Summary string // what this section governs
Example string // inline YAML snippet
Notes []string // gotchas, special semantics
}
SectionOverride provides framing and context for a top-level config key.
Source Files
Click to show internal directories.
Click to hide internal directories.