Skip to content

docs/usermanuals/en/training/dpo.md: broken example — Safety YAML with severity_thresholds: {S1: 0.05, S2: 0.05, S5: 0.10, S10: 0.05} (DOC-D3B05-012) #238

Open

Description

@cemililik

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

Summary

The production-safety example on this page cannot be loaded.

Primary finding

DOC-D3B05-012 — docs/usermanuals/en/training/dpo.md: broken example — Safety YAML with severity_thresholds: {S1: 0.05, S2: 0.05, S5: 0.10, S10: 0.05}

severity High

Where. docs/usermanuals/en/training/dpo.md:180-201 (Turkish mirror: docs/usermanuals/tr/training/dpo.md:179) · type: broken example

The document says. Safety YAML with severity_thresholds: {S1: 0.05, S2: 0.05, S5: 0.10, S10: 0.05}

What the code does. severity_thresholds keys must be one of SEVERITY_LEVELS ('critical','high','medium','low') (config.py:1070-1076, 1252). The snippet fails load: "severity_thresholds key 'S1' is not a recognized severity level", dry-run exit 1.

Code references. forgelm/config.py:978-985, forgelm/config.py:1070-1076, forgelm/config.py:1252

User impact. The production-safety example on this page cannot be loaded.

Proposed correction. Use severity_thresholds: {critical: 0, high: 0.01, medium: 0.05} and explain that keys are severity tiers, not S-codes.

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