Skip to main content

Crate krabka_docgen

Crate krabka_docgen 

Source
Expand description

Generates Zola markdown reference pages from Krabka’s in-process source-of-truth data structures.

These structures are the broker config schema, the topic configs, the protocol API catalog, and the recorded traces of the KRaft simulator. The tool links the broker as a library. It does not spawn the broker binary. Reference generation does not read Rust source; snippet synchronization reads the source regions that Markdown pages name.

docs/docgen-contract.md names every entry point the renderers read. crates/broker/tests/docgen_contract.rs holds the broker to that shape.

Modules§

broker
Generate the three broker reference pages.
emit
Wrap generated markdown bodies in Zola front matter and write the reference tree to disk.
scenarios
Render Krabka’s own deterministic consensus simulator into a Mermaid sequence-diagram “slideshow” markdown page.
schema_md
Render a JSON-Schema-shaped value to a markdown field table.
snippets
Sync fenced code blocks in website markdown from anchored regions of source files.

Functions§

sync_snippets
Rewrite snippet blocks in every .md under content_dir.