Skip to main content

Module compose

Module compose 

Source
Expand description

Composition surface: assemble canonical kaish guidance for an audience.

Content is a set of Fragments keyed by Concept / Variant / locale. A Selector (or a ready-made Recipe) chooses which fragments to render; compose assembles them into a single markdown string. Live, schema-derived content (the builtin index, per-tool help) is injected through the GeneratedContent trait so this crate stays free of the tool registry.

Design + resolved decisions: docs/composable-help.md.

Structs§

Fragment
A unit of content, addressed by (concept, key, variant, locale).
MissingFragment
A fragment present in English but missing in another locale.
Recipe
Ready-made Selectors so frontends never hand-build prose.
SchemaContent
GeneratedContent backed by a slice of tool schemas.
Selector
What to compose. Build one directly, or use a Recipe.

Enums§

Audience
Who the rendered content is for. A lens, not a fork: most fragments are shared (audience: None); the rare divergence is Some(_).
Concept
The “what” — concept taxonomy, organized for learning, not by audience.
Depth
How much to include. Summary is the always-on core; Reference adds detail.
Variant
The “how it’s said” — variations of one idea, used to reinforce.

Constants§

DEFAULT_LOCALE
Default (and canonical-complete) content locale.

Traits§

GeneratedContent
Live, schema-derived content the static fragments can’t hold.

Functions§

compose
Compose canonical kaish guidance into a single markdown document.
coverage
Report the English fragments that have no translation in locale.
render_syntax_reference
Render the Syntax concept as a standalone reference document.