Skip to content

docs: bring back the French documentation as translations of the current pages - #21

Merged
MotherSphere merged 2 commits into
mainfrom
docs/restore-french-docs
Oct 14, 2026
Merged

MotherSphere merged 2 commits into
mainfrom
docs/restore-french-docs

Conversation

@MotherSphere

Copy link
Copy Markdown
Member

PR #18 rewrote the README and documentation in English and, in doing so, deleted the French originals (docs/docs.md, docs/filebot_parity.md, docs/metadata_sources.md). Lin wanted the French kept. This brings it back, not as the old pages (which described the egui interface and a spec that no longer matches the code) but as French translations of the current English pages, kept honest by CI the same way Eidos does it.

What changes

English, first. A few facts from the old French pages were still true and had not made it into the English:

  • docs/metadata-sources.md: per source, what KayaBot keeps from an answer (title, year field, what it uses as the source rating: TMDB vote_average / 10, TheTVDB and TVmaze the search score, OMDb a fixed 0.7), and the published quotas (TMDB around 40 requests per second since the 2019 limit was dropped, TVmaze at least 20 calls per 10 seconds per IP, OMDb 1,000 requests a day on a free key), each checked against the service's current page. The old French TMDB figure (40 per 10 seconds) is out of date and was not carried over.
  • docs/filebot-parity.md: collection folders, subtitle language suffixes and subtitle downloads, which the old French parity spec listed as FileBot features to cover.
  • docs/architecture.md: the French release tags (VF, VOSTFR) the title clean-up removes.
  • README.md: a short ## Language section linking the French pages.

French translations under docs/i18n/fr/, which mirrors the repository root:

  • docs/i18n/fr/README.md
  • docs/i18n/fr/docs/architecture.md
  • docs/i18n/fr/docs/metadata-sources.md
  • docs/i18n/fr/docs/filebot-parity.md

Interface labels use the wording of src/i18n/fr.json (Renommer, Recherche, Associer, Simulation, Connexions...). Anchors point at the French headings, and links to files outside the docs (LICENSE, .env.example, the release page) are rewritten for the deeper path.

Checks, copied unchanged from Project-Colony/Eidos: scripts/i18n-check.sh (each translation's eidos-i18n stamp must match git hash-object of its English source, and the headings, code fences and table rows must match) and scripts/i18n-links.py (every markdown link and anchor resolves). A new translations up to date job in ci.yml runs both, with the same pinned actions/checkout as the other jobs. The stamp keeps the eidos-i18n name so the scripts stay byte for byte the same as Eidos's.

Both pass locally: 4 translation(s) checked and 10 markdown file(s) checked, every link resolves.

When an English page changes, its translation now goes stale and CI says so: re-translate and run ./scripts/i18n-check.sh --fix, or delete the translation.

@MotherSphere
MotherSphere merged commit a861962 into main Oct 14, 2026
8 checks passed
@MotherSphere
MotherSphere deleted the docs/restore-french-docs branch October 14, 2026 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant