Reference
Reference
Generated references, rebuilt from the source tree so they cannot drift
from the code. Each is produced by a script under tools/docs/, and the
Pages workflow fails if the committed pages differ from a fresh run.
- Configuration — every parameter in every
component's
config/config.xmland every plugin manifest, with its label, type, default, options, and description resolved from the language files. - REST API — every endpoint under
/api/, from the@apiMethod,@apiUri, and@apiParameterdocblock tags the API explorer incom_developeralso reads. - Muse — the console commands and their tasks, from the
@museDescriptiondocblocks. - Events — every event the CMS fires through
Event::trigger(), with its call sites, arguments, and the plugins that listen.
To regenerate after changing a manifest, a controller, or a command:
for g in config muse events api; do python3 tools/docs/gen_${g}_reference.py; done
python3 gh-pages/build_site.py
The narrative counterparts live in the Developers book.
Rewritten and checked on 2026-09-09.