Skip to content

[Wave 4] Low/info — Docs: docs/guides/air_gap_deployment.md #722

Open

Description

@cemililik

Wave 4 · 5 finding(s) in 5 fix package(s). One pass over this document; keep the Turkish mirror in sync.

Findings

  • DOC-D2B05-024 (docs, Low) — docs/guides/air_gap_deployment.md: misleading — "Every step emits structured audit events (cache.populate_*)"
    severity Low
    Where. docs/guides/air_gap_deployment.md:30 · type: misleading
    The document says. "Every step emits structured audit events (cache.populate_*)"
    What the code does. Only cache-models and cache-tasks (steps 1-2) emit cache.populate_* events, and only when AuditLogger can be constructed. Bundling, doctor and training emit none of these.
    Code references. forgelm/cli/subcommands/_cache.py:49-59, forgelm/cli/subcommands/_cache.py:286-293
    Proposed correction. "The two cache steps emit structured audit events (cache.populate_*)..."
    Turkish mirror. the Turkish page has the same error; fix both in the same PR

  • DOC-D2B05-025 (docs, Low) — docs/guides/air_gap_deployment.md: stale — forgelm doctor emits one row per probed extra (nine as of this writing)
    severity Low
    Where. docs/guides/air_gap_deployment.md:122 · type: stale
    The document says. forgelm doctor emits one row per probed extra (nine as of this writing)
    What the code does. 10 extras rows (qlora, unsloth, distributed, eval, tracking, tracking-mlflow, export, ingestion, ingestion-pii-ml, ingestion-scale).
    Code references. forgelm/cli/subcommands/_doctor.py:97-111, docs/reference/doctor_subcommand.md:33
    Proposed correction. Replace 'nine' with 'ten'.
    Turkish mirror. the Turkish page has the same error; fix both in the same PR

  • DOC-D2B05-026 (docs, Low) — docs/guides/air_gap_deployment.md: stale — doctor emits one row per probed extra, "nine as of this writing"
    severity Low
    Where. docs/guides/air_gap_deployment.md:122 (Turkish mirror: docs/guides/air_gap_deployment-tr.md:122) · type: stale
    The document says. doctor emits one row per probed extra, "nine as of this writing"
    What the code does. 10 extras are probed.
    Code references. forgelm/cli/subcommands/_doctor.py:98-111
    Proposed correction. "(ten as of this writing)"
    Turkish mirror. the Turkish page has the same error; fix both in the same PR

  • DOC-D2B05-027 (docs, Low) — docs/guides/air_gap_deployment.md: misleading — "gated models require the same HF_TOKEN to be set during cache-models as during the actual training run"
    severity Low
    Where. docs/guides/air_gap_deployment.md:209 (Turkish mirror: docs/guides/air_gap_deployment-tr.md:209) · type: misleading
    The document says. "gated models require the same HF_TOKEN to be set during cache-models as during the actual training run"
    What the code does. In offline mode the trainer skips HF authentication entirely, and cached files load without a token. A token is needed only on the staging host for the download.
    Code references. forgelm/cli/_training.py:136-139
    Proposed correction. "gated models need HF_TOKEN on the staging host during cache-models; the offline training run does not authenticate."
    Turkish mirror. the Turkish page has the same error; fix both in the same PR

  • DOC-D2B05-043 (docs, Low) — docs/guides/air_gap_deployment.md: wrong detail — forgelm doctor emits one row per probed extra ('nine as of this writing')
    severity Low
    Where. docs/guides/air_gap_deployment.md:122 (Turkish mirror: docs/guides/air_gap_deployment-tr.md) · type: wrong detail
    The document says. forgelm doctor emits one row per probed extra ('nine as of this writing')
    What the code does. _OPTIONAL_EXTRAS has 10 entries: qlora, unsloth, distributed, eval, tracking, tracking-mlflow, export, ingestion, ingestion-pii-ml, ingestion-scale.
    Code references. forgelm/cli/subcommands/_doctor.py:98-110
    Proposed correction. Say 'ten' or drop the number.
    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.

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