kaish-help 0.8.1

Composable help & instructions content for kaish — shared by the kernel, REPL, MCP server, and embedders
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

//! Composable help & instructions for kaish.
//!
//! kaish's canonical guidance lives here, once, so the kernel `help` builtin, the
//! REPL, the MCP server, and external embedders (kaijutsu, kaibo) all build their
//! human- and agent-facing instructions on the same source — a kaish release pushes
//! updates everywhere instead of each frontend hand-rolling prose that drifts.
//!
//! Two surfaces:
//!
//! - [`topic`] — the `help <topic>` command / MCP-prompt compatibility surface:
//!   [`get_help`], [`list_topics`], [`HelpTopic`]. Whole embedded markdown docs.
//! - [`compose`] — the composition surface: a concept-organized [`Fragment`] model
//!   ([`Concept`] / [`Variant`] / [`Audience`] / [`Depth`] / locale) assembled by
//!   [`compose`](compose::compose) via [`Selector`]s and ready-made [`Recipe`]s.
//!
//! Design: `docs/composable-help.md`.

pub mod compose;
pub mod content;
pub mod fragments;
pub mod topic;

// Compatibility surface — the `help <topic>` command and MCP prompts.
pub use topic::{get_help, list_topics, HelpTopic};

// Composition surface — recipes for frontends and embedders.
pub use compose::{
    compose, coverage, render_syntax_reference, Audience, Concept, Depth, Fragment,
    GeneratedContent, MissingFragment, Recipe, SchemaContent, Selector, Variant, DEFAULT_LOCALE,
};