Skip to main content

Module help

Module help 

Source
Expand description

Help system for kaish.

The content and composition logic now live in the kaish-help crate so the kernel, REPL, MCP server, and embedders share one canonical source. This module re-exports that surface; existing crate::help::{get_help, HelpTopic, ...} paths keep working. See docs/composable-help.md.

Modules§

compose
Composition surface: assemble canonical kaish guidance for an audience.

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.
HelpTopic
Help topics available in kaish.
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.
get_help
Get help content for a topic.
list_topics
List available help topics (for autocomplete, etc.).
tool_help
Format help for a single tool, or None if no such tool is registered.