Skip to content

Unit 10: Prepare the three untranslated MkDocs repos for translation #149

Description

@mairas

Target repos: halos-org/docs (34 pages), hatlabs/halser (17), hatlabs/sh-wg (9).

  • hatlabs/sh-wg
  • hatlabs/halser
  • halos-org/docs

Goal: Each repo has the layout the translation tooling expects, so Unit 9's wiring applies to it unchanged and translation can begin.

Dependencies: none. This is layout work the tooling then consumes; nothing blocks it.

Template: hatlabs/sh-esp32 commit 5956bf41, "feat(i18n): set up Finnish translation machinery for SH-ESP32". It is the most recent of the four and its message records each decision with its reason. halmet 107e5195 and sh-rpi 6627593f are the same change in the two siblings before it.

Approach, following that commit:

  • English moves under docs/en/; mkdocs-static-i18n serves each further locale from docs/<locale>/ in folder mode. All three repos are flat today.
  • Shared and per-page media/ directories stay outside the language trees, so one asset is not copied per locale. Count image references before and after; every one must still resolve.
  • Remove print-site. All three have it, and the four translated repos had it before their i18n commits removed it. The reason is not the anchor checker: print-site has no i18n support, so it would point a translated page at an English PDF.
  • edit_uri is wrong in several repos — sh-esp32's pointed at a path the repo does not have, the third to carry that fault. Verify each against the GitHub API rather than copying a sibling's.
  • Per-locale site_name, site_description, admonition_translations and nav_translations are authored per repo, not inherited.
  • Pick each repo's glossary by counting how often the candidate glossaries' terms actually occur in that repo's pages. sh-esp32 took HALMET's over HALPI2's on that evidence: the two Raspberry Pi power-board terms scored zero there.
  • Add the repo's .claude/skills/translate-page/SKILL.md, referring to the packaged entry points rather than to scripts/….

Verification:

  • mkdocs build --strict clean and check-anchors site passing after the move, with the same number of resolved image references as before.
  • translation-status runs and reports the English tree rather than erroring, with no locale configured beyond en.

Knock-on: removing print-site retires halos-org/shared-workflows#44 for our repos, and makes docs.halos.fi's --exclude 'print_page/*' dead code to drop in the same change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions