Skip to content

[Wave 4] Low/info — Docs: site/ #797

Open

Description

@cemililik

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

Findings

  • DOC-D4B07-026 (docs, Low) — site/index.html: broken example — References https://forgelm.dev/assets/og.png, favicon.ico, apple-touch-icon.png.
    severity Low · already tracked: KNOWN-OPEN DOCS-15|DOCS-14|DOCS-16 docs/roadmap/phase-16-trust-surface-hardening.md:787-788
    Where. site/index.html:13, 32, 33 · type: broken example
    The document says. References https://forgelm.dev/assets/og.png, favicon.ico, apple-touch-icon.png.
    What the code does. The files do not exist in site/; site/README.md:83-86 records this as a known gap.
    Code references. site/README.md:83-86
    Proposed correction. Add the assets or remove the tags until they exist.

  • DOC-D4B07-027 (docs, Low) — site/index.html: misleading — Drop your regulatory corpus into forgelm ingest, audit it, and SFT a model ... — with PII redacted at ingest, before training.
    severity Low
    Where. site/js/translations.js:401 · type: misleading
    The document says. Drop your regulatory corpus into forgelm ingest, audit it, and SFT a model ... — with PII redacted at ingest, before training.
    What the code does. PII is redacted only when --pii-mask (or --all-mask) is passed to forgelm ingest, which is off by default (ingest --help). The domain-expert template README's ingest example omits it (forgelm/templates/domain-expert/README.md:13-14).
    Code references. forgelm/cli/_parser.py, forgelm/templates/domain-expert/README.md:13-14
    Proposed correction. "...— run forgelm ingest --all-mask to redact PII and secrets at ingest, before training."

  • DOC-D4B07-028 (docs, Low) — site/index.html: misleading — Code copilot fine-tune: Multi-dataset mix (your repo + open code) with SFT (ORPO is a follow-up step you can chain), GGUF export at q4_k_m ... Synthetic data pipeline di…
    severity Low
    Where. site/js/translations.js:405 · type: misleading
    The document says. Code copilot fine-tune: Multi-dataset mix (your repo + open code) with SFT (ORPO is a follow-up step you can chain), GGUF export at q4_k_m ... Synthetic data pipeline distils a teacher into your student. [tag: forgelm quickstart code-assistant]
    What the code does. The code-assistant template is a single-dataset SFT config with no extra_datasets/mix_ratio and no synthetic block (forgelm/templates/code-assistant/config.yaml). Mixing (config.py:810-830), export and --generate-data are separate steps the user must add. A q4_k_m export yields f16 plus a manual step (export.py:265-292).
    Code references. forgelm/templates/code-assistant/config.yaml, forgelm/config.py:810-830, forgelm/export.py:265-292
    Proposed correction. "Start from the code-assistant SFT template; add data.extra_datasets + mix_ratio to blend your repo with open code, chain ORPO with a pipeline stage, and export to GGUF (--quant q8_0, or q4_k_m via a follow-up llama-quantize)."

  • DOC-D4B08-024 (docs, Low) — site/README.md: wrong detail — Structure tree of site/ (js/ lists seven files)
    severity Low
    Where. site/README.md:19-41 · type: wrong detail
    The document says. Structure tree of site/ (js/ lists seven files)
    What the code does. The tree omits the generated js/usermanuals/ directory that guide.html loads (site/guide.html:38-39). It is gitignored (.gitignore:12) and built at deploy time.
    Code references. site/guide.html:38-39, .gitignore:12
    Proposed correction. Add '│ └── usermanuals/ # GENERATED (gitignored) by tools/build_usermanuals.py'.

  • DOC-D4B08-025 (docs, Low) — site/README.md: stale — Bilingual — EN / TR via data-lang spans + localStorage; i18n.js is an 'EN/TR site-chrome language switcher'; privacy/terms '(EN + TR)'.
    severity Low · already tracked: KNOWN-OPEN C31-LOCALIZATION-GOV docs/roadmap/phase-16-trust-surface-hardening.md:809-810
    Where. site/README.md:48, site/README.md:34, site/README.md:27-28 · type: stale
    The document says. Bilingual — EN / TR via data-lang spans + localStorage; i18n.js is an 'EN/TR site-chrome language switcher'; privacy/terms '(EN + TR)'.
    What the code does. The site has 6 locales (en/tr/de/fr/es/zh; site/js/i18n.js:27; translations.js:21-161). Switching uses data-i18n / data-i18n-html / data-i18n-attr attributes (i18n.js:87-118), and no data-lang attribute exists anywhere in site/. The README's own structure line for translations.js (:36) already says 6-locale.
    Code references. site/js/i18n.js:27, site/js/i18n.js:87-118, site/js/translations.js:21-161
    Proposed correction. 'Six locales (EN/TR/DE/FR/ES/ZH) via data-i18n* attributes resolved from js/translations.js; choice persisted in localStorage (forgelm-lang).' Update the i18n.js, privacy.html and terms.html lines to match.

  • DOC-D4B08-031 (docs, Low) — site/quickstart.html: stale — Answer 7 questions
    severity Low · already tracked: KNOWN-OPEN DOCS-14|DOCS-15|DOCS-16 docs/roadmap/phase-16-trust-surface-hardening.md:771-772
    Where. site/quickstart.html:167 (HTML no-JS fallback) · type: stale
    The document says. Answer 7 questions
    What the code does. The wizard has 9 steps (site/js/wizard.js:940-950). The EN translation says 'Answer 9 questions' (translations.js:1860), so only no-JS readers and crawlers see 7, which contradicts the '9 guided steps' shown beside it.
    Code references. site/js/wizard.js:940-950, site/js/translations.js:1860
    Proposed correction. Set the fallback to 'Answer 9 questions' and the snippet to 'use case · trainer · model · data · risk'.

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
    backlog: knownAlready tracked in docs/roadmap
    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
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

    backlog: knownAlready tracked in docs/roadmapdocumentationImprovements 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