soothfast_docs/lib.rs
1//! Soothfast docs engine.
2//!
3//! Four rot channels, four mechanisms:
4//! - signatures can't rot: the API surface is read from rustdoc JSON
5//! ([`surface`], [`mod@reference`], [`diff`]);
6//! - prose can't rot silently: bind blocks fingerprint the code they
7//! describe, locked in `soothfast.lock` ([`markdown`], [`lockfile`]);
8//! - examples can't rot: every markdown `rust` block becomes a generated
9//! test, capture blocks become runnable examples ([`gentests`]);
10//! - numbers can't rot: quantitative claims in prose evaluate against the
11//! latest measurement baseline ([`claims`]).
12
13mod comments;
14
15pub mod claims;
16pub mod diff;
17pub mod gentests;
18pub mod lockfile;
19pub mod markdown;
20pub mod reference;
21pub mod surface;