Skip to content

[Wave 4] Low/info — TR mirror: docs/usermanuals/en/concepts/ #812

Open

Description

@cemililik

Wave 4 · 3 finding(s) in 3 fix package(s). Mirror drift across small document pairs in this directory.

Findings

  • DOC-TR13-003 (TR mirror, Low) — TR mirror drift in docs/usermanuals/en/concepts/alignment-overview.md: ## Where to go next
    severity Low
    Where. EN alignment-overview.md:117-121 (heading 'Where to go next') · TR alignment-overview.md:117 ('## Sıraki adım')
    English text. ## Where to go next
    Turkish text. ## Sıraki adım
    Which is correct. EN (TR has a typo)
    Proposed correction (Turkish text for the -tr page). ## Sıradaki adım

  • DOC-TR13-004 (TR mirror, Low) — TR mirror drift in docs/usermanuals/en/concepts/data-formats.md: completion → the model's response (the field name TRL's KTOTrainer expects; ForgeLM's _detect_dataset_format keys off completion… severity **Low** **Where.** EN [data-formats.md:89](https://github.com/HodeTech/ForgeLM/blob/cab2947/data-formats.md#L89) (completionfield meaning +_detect_dataset_format keys off completion+label to auto-route to KTO) · TR [data-formats.md:88-90](https://github.com/HodeTech/ForgeLM/blob/cab2947/data-formats.md#L88-L90) (only label meanings; the completionbullet is absent) **English text.**completion→ the model's response (the field name TRL's KTOTrainer expects; ForgeLM's_detect_dataset_formatkeys offcompletion + labelto auto-route to KTO). **Turkish text.** (bullet missing; list starts at 'label: true → istenen yanıt') **Which is correct.** TR omission is harmless: the dropped sentence is the inaccurate one (detection is advisory only, data.py:23-50). Thecompletionfield meaning is still useful. **Proposed correction (Turkish text for the -tr page).** -completion→ modelin yanıtı (TRL KTOTrainer'ın beklediği alan adı; sütunlarcompletion+labeliçermezse ForgeLMKeyError` verir, formatı otomatik yönlendirmez).

  • DOC-TR13-005 (TR mirror, Low) — TR mirror drift in docs/usermanuals/en/concepts/data-formats.md: """Return a scalar in [-1, 1] (or any bounded range).""" and comments '# your parsing logic', '# malformed'
    severity Low
    Where. EN data-formats.md:106-114 (reward() docstring 'Return a scalar in [-1, 1] (or any bounded range)') · TR data-formats.md:105-112 (docstring absent)
    English text. """Return a scalar in [-1, 1] (or any bounded range).""" and comments '# your parsing logic', '# malformed'
    Turkish text. (docstring and inline comments removed)
    Which is correct. Neither: the whole reward(prompt,response,ground_truth) example is not wired in ForgeLM (see D-0940); TR drops only comments.
    Proposed correction. Replace the example in both languages with the supported flow: dataset column gold_answer + leave grpo_reward_model null, or an HF reward model id.

Done when

  • Every finding above is fixed or closed with a reason (tick it here).
  • Code fixes carry a test; doc fixes update the Turkish mirror in the same PR.

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
    i18nEnglish/Turkish documentation mirror
    severity: lowMinor defect, inaccuracy or rough edge
    source: review-2026-10Found by the October 2026 code and documentation review
    wave: 4Roadmap wave 4: low / info / watch, when touching the module
    on Oct 9, 2026
  2. cemililik commented on Oct 11, 2026

    @cemililik
    CollaboratorAuthor

    Where to start

    Thanks for taking a look. Please confirm the issue is unassigned and comment before starting so work does not overlap.

    Start with these files on development:

    Fix the TR heading typo, explain completion in both languages without claiming automatic trainer routing, and replace the unwired custom-Python reward example with the supported gold_answer plus null grpo_reward_model flow. Keep Python code/comments identical and English.

    Run the focused tests:

    pytest tests/test_data.py tests/test_trainer_grpo_config.py --no-cov

    Run these guards/checks as applicable to the changed files:

    ruff format --check forgelm/data.py forgelm/trainer.py tests/test_data.py tests/test_trainer_grpo_config.py
    ruff check forgelm/data.py forgelm/trainer.py tests/test_data.py tests/test_trainer_grpo_config.py
    python3 tools/check_bilingual_parity.py --strict
    python3 tools/check_bilingual_code_blocks.py --strict
    python3 tools/check_anchor_resolution.py --strict
    python3 tools/check_tr_links_prefer_mirror.py --strict
    python3 tools/check_usermanual_self_contained.py --strict
    python3 tools/check_usermanual_schema_drift.py --strict

    If user-facing documentation changes, update the existing Turkish mirror in the same PR; keep commands, code and terminal output in English and structurally aligned. English-only contributor standards need no new mirror.

    Open the PR against development with Fixes #812 once every finding is resolved or explicitly closed with a reason; use Refs #812 for partial work and list the resolved finding IDs.

  3. added
    help wantedExtra attention is needed
    and removed on Oct 15, 2026
  4. cemililik commented on Oct 15, 2026

    @cemililik
    CollaboratorAuthor

    I'm removing good first issue here and marking this help wanted: it needs natural Turkish written or reviewed by a native or near-native speaker. docs/standards/localization.md does not accept unreviewed machine translation (see its "No machine-translation output" rule), so please only claim this issue if that describes you, and say in the PR who reviewed the Turkish text.

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 documentationhelp wantedExtra attention is neededi18nEnglish/Turkish documentation mirrorseverity: lowMinor defect, inaccuracy or rough edgesource: review-2026-10Found by the October 2026 code and documentation reviewwave: 4Roadmap wave 4: low / info / watch, when touching the module

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions