Skip to main content

Module guide

Module guide 

Source
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::GuideView form 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:

Structs§

GuideEntry
One named row within a guide section or canonical bucket.
GuideSection
One logical section within a GuideView.
GuideView
Structured help/guide payload shared by the CLI, REPL, renderers, and semantic output pipeline.

Enums§

GuideSectionKind
Canonical section kinds used by structured help output.