shiplog-render-md 0.4.0

Markdown self-review packet renderer for canonical shiplog data.
Documentation

shiplog-render-md

Markdown packet renderer for canonical shiplog data.

Main type

  • MarkdownRenderer implements shiplog_ports::Renderer.

Output behavior

  • Includes coverage summary, completeness, sources, and warnings.
  • Separates completed sources, skipped configured sources, and known gaps in the packet coverage block.
  • Renders workstream sections with claim scaffolds and receipt lists.
  • Truncates long receipt lists in the main section and emits a configurable appendix.
  • Includes artifact references (ledger.events.jsonl, coverage.manifest.json, etc.).

MarkdownRenderer::render_packet_markdown keeps the default full packet behavior. render_scaffold_markdown emits coverage, summary, workstream prompts, and evidence anchors without the full receipts appendix. render_receipts_markdown emits a dense receipt/audit view.

Use MarkdownRenderOptions with the *_with_options methods to control main-section receipt limits and choose a full, summary, or omitted appendix. A receipt limit of 0 intentionally shows no main-section receipts while keeping an omission notice when appendix detail is reduced.

The output is intentionally editable: users can refine narrative text directly in packet.md.