@kekkai/blueprint / emitHandbook

Function: emitHandbook()

emitHandbook(blueprint, stack?): string

Defined in: src/emit/docs/docs.ts:38

Compile a Blueprint into a human-readable Handbook (markdown). Pure and deterministic — the same blueprint always yields the same string, so Bootstrap can hash it to decide whether a rewrite is needed. Sections with no data are omitted. stack carries the fact no Blueprint holds, which decides whether the Rules table may name a machine for explicitAny.

Parameters

blueprint

Blueprint

stack?

StackFacts = {}

Returns

string

Example

import { writeFileSync } from 'node:fs';

writeFileSync('docs/architecture-handbook.md', emitHandbook(blueprint));