Skip to content

docs/usermanuals/en/operations/cicd.md: broken example — forgelm --config configs/run.yaml --output-format json | jq '.verdict' prints "success". (DOC-D3B02-016) #216

Open

Description

@cemililik

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

Summary

CI logic keyed on .verdict never sees "success".

Primary finding

DOC-D3B02-016 — docs/usermanuals/en/operations/cicd.md: broken example — forgelm --config configs/run.yaml --output-format json | jq '.verdict' prints "success".

severity High

Where. docs/usermanuals/en/operations/cicd.md:148-151 (Turkish mirror: docs/usermanuals/tr/operations/cicd.md:149-152) · type: broken example

The document says. forgelm --config configs/run.yaml --output-format json | jq '.verdict' prints "success".

What the code does. The training JSON envelope has success, metrics, final_model_path, reverted, awaiting_approval, run_id, config_hash, staging_path, benchmark, safety and judge, and no verdict. jq prints null.

Code references. forgelm/cli/_result.py:113-129, forgelm/cli/_result.py (_build_result_json_envelope)

User impact. CI logic keyed on .verdict never sees "success".

Proposed correction. $ forgelm --config configs/run.yaml --output-format json | jq '.success' → true (also .awaiting_approval, .reverted).

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.

Activity

  1. added
    documentationImprovements or additions to documentation
    severity: highWrong behaviour or a false claim users rely on
    source: review-2026-10Found by the October 2026 code and documentation review
    wave: 1Roadmap wave 1: high severity, small effort
    on Oct 9, 2026
  2. cemililik commented on Oct 22, 2026

    @cemililik
    CollaboratorAuthor

    Triage note (2026-10-22). This example sits in the same section as #433, which also covers the false stdout sentence under it, and one pull request fixes both. #433 now carries good first issue and a "Where to start" with the agreed change. To work on this, claim #433 (comment /assign there); its PR closes this issue too with Fixes #216.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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