Skip to content

docs/usermanuals/en/operations/troubleshooting.md: broken example — Disable specific quality checks in YAML with audit: quality_filter: skip: ["min_alpha_ratio", "max_bullet_ratio"]. (DOC-D3B04B-010) #228

Open

Description

@cemililik

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

Summary

Pasting the snippet into a training config makes it fail to load (exit 1).

Primary finding

DOC-D3B04B-010 — docs/usermanuals/en/operations/troubleshooting.md: broken example — Disable specific quality checks in YAML with audit: quality_filter: skip: ["min_alpha_ratio", "max_bullet_ratio"].

severity High · already tracked: KNOWN-OPEN C31-DOC-SCHEMA-PROSE docs/roadmap/phase-16-trust-surface-hardening.md:785-786

Where. docs/usermanuals/en/operations/troubleshooting.md:106-116 (Turkish mirror: docs/usermanuals/tr/operations/troubleshooting.md:106-116) · type: broken example

The document says. Disable specific quality checks in YAML with audit: quality_filter: skip: ["min_alpha_ratio", "max_bullet_ratio"].

What the code does. ForgeConfig has no audit section, so the snippet fails validation (verified: 'audit — Extra inputs are not permitted'). The quality filter is a CLI flag of forgelm audit and can only be switched on or off as a whole (--no-quality-filter). The check ids are low_alpha_ratio, low_punct_endings, abnormal_mean_word_length, short_paragraphs and repeated_lines (forgelm/data_audit/_quality.py:22-28). There is no 'max_bullet_ratio'.

Code references. forgelm/data_audit/_quality.py:22-28, forgelm/cli/_parser.py:530

User impact. Pasting the snippet into a training config makes it fail to load (exit 1).

Proposed correction. Fix: per-check skipping is not supported. Either run forgelm audit <data> --no-quality-filter, or keep the filter on and treat quality_summary.by_check (low_alpha_ratio, low_punct_endings, …) as advisory for code/symbol-heavy data — quality flags never change the exit code.

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

    backlog: knownAlready tracked in docs/roadmapblockedWaits for another issue (see Blocked by); set and removed automatically, never by handdocumentationImprovements 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