docs/usermanuals/en/reference/yaml-templates.md: broken example — 'Materialise any of them with: forgelm quickstart <template-name> --output config.yaml', followed by --dry-run and then training. (DOC-D3B04A-008) #222

Wave 1 · theme D1-10: Documentation-only fixes · highest severity High · 1 finding(s) · effort docs fix

Summary

A user who only wants to inspect and adapt the template triggers a model download and a full GPU training run, then a chat session, before the documented dry-run step.

Primary finding

DOC-D3B04A-008 — docs/usermanuals/en/reference/yaml-templates.md: broken example — 'Materialise any of them with: forgelm quickstart <template-name> --output config.yaml', followed by --dry-run and then training.

severity High

Where. docs/usermanuals/en/reference/yaml-templates.md:11-17 (Turkish mirror: docs/usermanuals/tr/reference/yaml-templates.md:14-16) · type: broken example

The document says. 'Materialise any of them with: forgelm quickstart <template-name> --output config.yaml', followed by --dry-run and then training.

What the code does. Without --dry-run, forgelm quickstart TEMPLATE generates the config, immediately starts training in a subprocess, and then launches forgelm chat. Only --dry-run stops after generating the config.

Code references. forgelm/cli/subcommands/_quickstart.py:233-293, forgelm/cli/_parser.py:142-191

User impact. A user who only wants to inspect and adapt the template triggers a model download and a full GPU training run, then a chat session, before the documented dry-run step.

Proposed correction. shell $ forgelm quickstart <template-name> --output config.yaml --dry-run # generate only $ forgelm --config config.yaml --dry-run $ forgelm --config config.yaml and add: "Without --dry-run, forgelm quickstart starts training right away and then opens forgelm chat (skip chat with --no-chat)."

Turkish mirror. the Turkish page has the same error; fix both in the same PR

Acceptance criteria

• Each statement is re-checked against the code at fix time.
• Documentation listed above is corrected in English and in its Turkish mirror in the same PR.
• Every finding in this issue is resolved or explicitly closed with a reason.

_{Found by the October 2026 ForgeLM code and documentation review against commit cab2947. Code links point at that commit; line numbers may have moved since. Finding IDs (CR-…, DOC-…, TECH-…) are stable references for this backlog.}