Documentation
¶
Overview ¶
Command magus-examples keeps the worked examples in the docs honest: it builds the current magus binary, runs curated retrieval-verb invocations against a small fixture workspace, captures their ACTUAL stdout, and injects each into docs/knowledge.md between HTML markers (<!-- example:<slug> --> ... <!-- /example -->). So the example output is never hand-typed - it is exactly what `magus explain`/`path` print, from a controlled fixture with stable IDs (same approach the txtar tests use, just captured instead of asserted). It mirrors magus-spelldocs (derive committed Markdown from a source of truth) and rides the same generate + vcs.isDirty drift gate: change the renderer, forget to regenerate, and CI fails.