magus-spelldocs

command
v0.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 3, 2026 License: GPL-3.0 Imports: 15 Imported by: 0

Documentation

Overview

Command magus-spelldocs generates Markdown reference documentation for every built-in spell in the internal/spellruntime registry. It mirrors cmd/magus-docs: walk the registry, emit one page per spell to docs/spells/<name>.md (injecting a per-op example from spells/examples/<name>/<op>.buzz), and refresh the built-in-spell table on the /spells/ landing (docs/spells.md) between its marker comments.

go run ./cmd/magus-spelldocs -out ./docs/spells

The output under docs/spells is committed; re-run this (via `magus run content-generate docs`) after changing a spell. Spell examples are marked runnable as dry-run (<!-- magus-run-recorder -->): the playground's recorder (Eval + WithTracer) records the tool invocations a target would trigger instead of executing them, so a reader sees the plan without the toolchain installed.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL