Skip to main content

Module model

Module model 

Source
Expand description

The data model: identifiers, types, lifecycle and documents.

Re-exports§

pub use doc::Doc;
pub use doc::FileEntry;
pub use doc::Located;
pub use doc::Tier;
pub use doctype::Form;
pub use doctype::KeyKind;
pub use doctype::TypeDef;
pub use id::DocId;
pub use id::RefText;
pub use registry::Registry;

Modules§

doc
A loaded document: where it lives, what its frontmatter says, and what its body points at.
doctype
Document types and the built-in preset that covers design, planning and maintenance material.
id
Document identifiers: <type>:<owner>/<key>, optionally followed by #<anchor>.
lifecycle
The status lifecycle shared by every type: draft → active → superseded | archived, and draft → rejected. No transition goes backwards.
registry
The type registry: the built-in preset with a project’s overrides applied.
stamp
UTC timestamps used as document keys, and ISO dates used in frontmatter.