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

[ ai, bsd3, library, program ] [ Propose Tags ] [ Report a vulnerability ]

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.

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0
Change log CHANGELOG.md
Dependencies base (>=4.20 && <5), okf-core (>=0.1.0.0 && <0.2), shikumi (>=0.2.0.0 && <0.3), shikumi-okf (>=0.1.0.0 && <0.2), text (>=2.1 && <2.2) [details]
License BSD-3-Clause
Author Nadeem Bitar
Maintainer nadeem@gmail.com
Uploaded by shinzui at 2026-06-28T23:50:05Z
Category AI
Distributions
Executables shikumi-okf-example
Downloads 4 total (4 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]