@hackage / shikumi-okf

Generate OKF documentation bundles from shikumi programs (EP-31)

Latest0.1.0.1

About

Metadata

  • Last updated , by shinzui
  • License BSD-3-Clause
  • Maintained by: nadeem@gmail.com

  • Lottery factor: 1

Links

Installation

Readme

An opt-in generator that documents shikumi Program values as an Open Knowledge Format (OKF) bundle: one Shikumi App concept that links to one Shikumi Program concept per program an application ships. Given a user-supplied Shikumi.Okf.Types.ProgramManifest of named programs, it builds Markdown concept documents (frontmatter + a body rendered from the program's structure and the author's declared metadata) and writes them to disk through the okf-core producer API. . The heavy okf-core dependency is isolated in this package — mirroring how shikumi-trace-otel quarantines the OpenTelemetry tree — so shikumi users who do not care about OKF never depend on it.