Skip to main content

Module bundle

Module bundle 

Source
Expand description

Loading and traversing an OKF bundle: a directory tree of markdown files.

Bundle::load walks a directory, parses every non-reserved .md file into a Concept, records the reserved index.md / log.md files, and builds two graphs over the result:

  • the cross-link graph from markdown links, with backlinks;
  • the derivation graph from sources[].resource entries that name another concept, which is how credibility propagates: “when a resource points at another OKF concept, the derivation edge already exists in the bundle graph, so a consumer MAY recurse into that source’s own sources.”

Loading is permissive by design: files whose frontmatter cannot be parsed are collected into Bundle::parse_errors rather than aborting the load, and broken links are retained as edges to non-existent concepts.

Structs§

Bundle
A loaded OKF bundle.
Concept
A single concept within a bundle (one markdown document).
ResolvedLink
A cross-link from one concept to another, after resolution.
ResolvedSource
A sources entry resolved against the bundle.

Constants§

RESERVED_FILENAMES
Reserved filenames with defined meaning at any level.