Skip to content

docs: machine-generated README.fr.md as a base for native review - #291

Draft
vsits-team-lead-agent[bot] wants to merge 1 commit into
mainfrom
docs/readme-fr-clean
Draft

docs: machine-generated README.fr.md as a base for native review#291
vsits-team-lead-agent[bot] wants to merge 1 commit into
mainfrom
docs/readme-fr-clean

Conversation

@vsits-team-lead-agent

Copy link
Copy Markdown
Contributor

Companion to #290. This is a machine translation, not a finished document — it exists so a francophone reviewer has something to correct rather than a blank file, which is a much smaller ask.

Produced with Qwen 3 running locally, section by section, with instructions to translate prose only and leave code fences, env var names, CLI flags, file paths, and the cache vocabulary (cache_read, prompt cache, TTL, cache breakpoint) in English. Scope matches README.zh.md: Quick Start, what the proxy defends against, recommended CC config, known CC behaviors, security model, the problem / how it works / graduating from fixes, safety, status line. 515 lines.

What I verified mechanically: 46/46 code fences intact, 10/10 headings present, all 40 CACHE_FIX_* identifiers unaltered. What I have not verified is whether it reads like French written by a person. I don't have the standing to judge that, which is the entire reason this is a draft.

Reviewers: please treat this as a starting point and change whatever is wrong. Awkward phrasing, wrong register, terminology a French SRE wouldn't use — all fair game, and corrections are more valuable than approval here. If some section is easier to rewrite than to fix, rewrite it.

Two spots I'd particularly like a second opinion on:

  • Whether "le cache" reads naturally throughout, or whether some of those should be "la mise en cache" / "le cache de prompt" depending on context.
  • The safety and security-model sections, where a mistranslation is worse than no translation. If either reads ambiguously, say so and I'll fix the English source too — ambiguity there usually means the original is unclear.

Not merging this on machine output alone. Holding for native review.

— AI Team Lead

NOT a finished translation. Generated by Qwen3-30B on our local GPU from
the same section scope README.zh.md uses, and it carries the errors you
would expect from a machine: 'jetons' where a French developer says
'tokens', 'tour de rechauffage' for warm turn, and idiom that is fluent
but not what an SRE would write.

Shipped anyway because reviewing 515 lines is a far smaller ask than
writing them, and a French reader today gets an English page. Structure
verified before commit: 46/46 code fences, 10/10 headings, 40/40
CACHE_FIX_* references, no prose left untranslated, and no cache
terminology wrongly localized (prompt cache, cache_read, TTL, cache
breakpoint deliberately left in English).

Precedent: Chris authored README.zh.md 2026-04-09 and Victor Sun
refreshed it in #178; ArkNill contributed README.ko.md. Same shape --
ship a base, a native speaker corrects it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant