Expand description
Structured help/guide view models and conversions. Structured help and guide payload model.
This module exists so help, intro, and command-reference content can travel through the app as semantic data instead of ad hoc rendered strings.
High level flow:
- collect guide content from command definitions or parsed help text
- keep it in
crate::guide::GuideViewform while other systems inspect, filter, or render it - lower it later into rows, documents, or markdown as needed
Contract:
- guide data should stay semantic here
- presentation-specific layout belongs in the UI layer
Public API shape:
crate::guide::GuideViewand related section/entry types stay intentionally direct to compose because they are semantic payloads- common generation paths use factories like
crate::guide::GuideView::from_textandcrate::guide::GuideView::from_command_def - rendering/layout policy stays outside this module so the guide model remains reusable
Structs§
- Guide
Entry - One named row within a guide section or canonical bucket.
- Guide
Section - One logical section within a
GuideView. - Guide
View - Structured help/guide payload shared by the CLI, REPL, renderers, and semantic output pipeline.
Enums§
- Guide
Section Kind - Canonical section kinds used by structured help output.