Skip to content

docs/usermanuals/en/reference/json-output.md: stale — The export example shows quant 'q4_k_m' written to model.q4_k_m.gguf, and the table lists 7 keys. (DOC-D3B03-008) #220

Open

Description

@cemililik

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

Summary

Consumers believe they received a q4_k_m GGUF and ship an f16 intermediate, missing the required llama-quantize step.

Primary finding

DOC-D3B03-008 — docs/usermanuals/en/reference/json-output.md: stale — The export example shows quant 'q4_k_m' written to model.q4_k_m.gguf, and the table lists 7 keys.

severity High

Where. docs/usermanuals/en/reference/json-output.md:867-888 (Turkish mirror: docs/usermanuals/tr/reference/json-output.md:871-892) · type: stale

The document says. The export example shows quant 'q4_k_m' written to model.q4_k_m.gguf, and the table lists 7 keys.

What the code does. K-quants (q2_k, q3_k_m, q4_k_m, q5_k_m), including the default q4_k_m, are written as an intermediate .f16.gguf with quant='f16', requested_quant='q4_k_m', manual_step_required=true and a followup_command (llama-quantize). The envelope also carries requested_quant, manual_step_required and followup_command, which the page does not document.

Code references. forgelm/cli/subcommands/_export.py:25-41, forgelm/export.py:52, forgelm/export.py:266-280, forgelm/export.py:466-482

User impact. Consumers believe they received a q4_k_m GGUF and ship an f16 intermediate, missing the required llama-quantize step.

Proposed correction. Document requested_quant, manual_step_required and followup_command. Change the example to a K-quant request that yields output_path '...model.f16.gguf', quant 'f16', manual_step_required: true. State that only q8_0/f16 are produced directly.

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