Skip to content

[Wave 4] Low/info — Docs: docs/usermanuals/en/training/ (part 2/2) #792

Open

Description

@cemililik

Wave 4 · 1 finding(s) in 1 fix package(s). Documents with fewer than five findings each in this wave, grouped by directory.

Findings

  • DOC-D3B06-046 (docs, Low) — docs/usermanuals/en/training/pipelines.md: wrong detail — "7 new event names cover every transition."
    severity Low
    Where. docs/usermanuals/en/training/pipelines.md:121 (Turkish mirror: docs/usermanuals/tr/training/pipelines.md:121) · type: wrong detail
    The document says. "7 new event names cover every transition."
    What the code does. The orchestrator also emits pipeline.resume_refused (forgelm/cli/_pipeline.py:562), an eighth pipeline-scoped event, alongside the seven listed (lines 685, 698, 715, 826, 1133, 1329, 1608).
    Code references. forgelm/cli/_pipeline.py:562
    Proposed correction. Add pipeline.resume_refused and change the count to 8.
    Turkish mirror. the Turkish page has the same error; fix both in the same PR

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
    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:

    Update the manual event count to eight and include pipeline.resume_refused with its actual meaning, matching the canonical audit catalog. Keep the two manual lists aligned; do not change event emission.

    Run the focused tests:

    pytest tests/test_pipeline_cli.py --no-cov

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

    ruff format --check forgelm/cli/_pipeline.py tests/test_pipeline_cli.py
    ruff check forgelm/cli/_pipeline.py tests/test_pipeline_cli.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
    python3 tools/check_audit_event_catalog.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 #792 once every finding is resolved or explicitly closed with a reason; use Refs #792 for partial work and list the resolved finding IDs.

  3. added
    help wantedExtra attention is needed
    and removed on Oct 17, 2026
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 neededseverity: 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