sim-cookbook 0.1.0

Cookbook engine for SIM: runnable, crate-local tutorial recipes.
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
31
32
33
34
35
36
37
38
39
40

//! Cookbook engine for SIM: runnable, crate-local tutorial recipes.
//!
//! A *recipe* is a tiny lesson -- a runnable setup (in Lisp or any registered
//! codec) plus a purpose document -- that ships inside the crate it teaches.
//! When a lib loads, it registers its recipes as Card records; the *cookbook*
//! is then a projection over those cards, grouped into books and chapters and
//! rendered by every surface (CLI, WebUI, browse, agent).
//!
//! This crate owns the kernel-free cookbook engine: manifest parsing and lint,
//! compile-time embedding, recipe stores, projection/search/next behavior, and
//! deterministic user overlays. Runtime operations live in `sim-lib-cookbook`;
//! the CLI, WebUI, browse/help, and agent surfaces all use that shared runtime
//! projection instead of parallel cookbook logic.

#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod embed;
mod embed_codegen;
mod manifest;
mod model;
mod overlay;
mod project;
mod store;
mod toml_lite;

pub use embed::{EmbeddedDir, recipes_from_embedded};
pub use embed_codegen::{generate_embed_code, write_embed};
pub use manifest::{
    BookManifest, ChapterManifest, DEFAULT_ORDER, Diagnostic, RecipeManifest, lint_dir, parse_book,
    parse_chapter, parse_recipe,
};
pub use model::{
    BookView, ChapterView, CheckResult, CookbookView, Expectation, RecipeCard, RecipeRun,
    RecipeSource,
};
pub use overlay::{OverlayDirectives, apply_directives, load_overlay, parse_overlay};
pub use project::{next, ordered_cards, search, view};
pub use store::RecipeStore;
pub use toml_lite::TomlValue;