Skip to content

docs/usermanuals/en/getting-started/first-run.md: broken example — forgelm quickstart customer-support --output configs/quickstart-customer-support.yaml generates the config so you can then dry-run… (DOC-D3B04B-002) #223

Open

Description

@cemililik

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

Summary

Following the walkthrough starts a GPU training run (and model download) before the user has validated or fit-checked anything, which defeats the documented flow.

Primary finding

DOC-D3B04B-002 — docs/usermanuals/en/getting-started/first-run.md: broken example — forgelm quickstart customer-support --output configs/quickstart-customer-support.yaml generates the config so you can then dry-run…

severity High

Where. docs/usermanuals/en/getting-started/first-run.md:85-100 (Turkish mirror: docs/usermanuals/tr/getting-started/first-run.md:88) · type: broken example

The document says. forgelm quickstart customer-support --output configs/quickstart-customer-support.yaml generates the config so you can then dry-run, fit-check and train it (steps 3-5).

What the code does. Without --dry-run, quickstart immediately spawns forgelm --config <generated> training and then auto-launches forgelm chat (forgelm/cli/subcommands/_quickstart.py:282-287, 189-230). Generate-only needs --dry-run (verified: with --dry-run it prints 'Dry-run only. To start training: forgelm --config ...').

Code references. forgelm/cli/subcommands/_quickstart.py:189-230, forgelm/cli/subcommands/_quickstart.py:282-287

User impact. Following the walkthrough starts a GPU training run (and model download) before the user has validated or fit-checked anything, which defeats the documented flow.

Proposed correction. $ forgelm quickstart customer-support --output configs/quickstart-customer-support.yaml --dry-run — and add: 'Without --dry-run, quickstart trains immediately and opens chat afterwards.'

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationseverity: highWrong behaviour or a false claim users rely onsource: review-2026-10Found by the October 2026 code and documentation reviewwave: 1Roadmap wave 1: high severity, small effort

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions