Skip to content

fix(docs): bring German/Traditional Chinese READMEs back in sync with English - #206

Merged
kevintseng merged 1 commit into
mainfrom
fix/readme-i18n-parity
Aug 24, 2026
Merged

fix(docs): bring German/Traditional Chinese READMEs back in sync with English#206
kevintseng merged 1 commit into
mainfrom
fix/readme-i18n-parity

Conversation

@kevintseng

Copy link
Copy Markdown
Contributor

Summary

Requested review of "the READMEs" turned up real drift between README.md and its two translations, found by reading all three side by side (check-doc-claims.mjs checks facts against code, not translation parity against the English source — this class of gap is outside what it looks for):

  • Missing section: README.zh-TW.md and README.de.md were both missing the entire "Recipes" section (three worked examples — catching a contradiction, one memory across three assistants, recording decisions with causal links) that exists in README.md. Added, translated to match each file's own established terminology and register (informal 你 in zh-TW per the rest of the file; formal Sie in de, matching the closest analogous walkthrough section).
  • Silently reduced content: both translations' "⚠️ Conflict Detection" Smart Feature bullet was a single generic sentence ("if you have two contradicting memories, MeMesh warns you"), while English carries three sentences of real detail — the actual command, the review workflow (dream list/dream show, nothing auto-applies), and the causality guarantee. Expanded both to match.
  • Stale hardcoded number: README.zh-TW.md's Contributing section had npm test # 630 項測試 — the exact "stale test count next to npm test" problem check-doc-claims.mjs's own check feat: v2.12.0 — Knowledge Evolution (soft-archive, supersedes, observation-level forget) #5 exists to prevent (its comment cites an earlier incident: "all eleven said 630 tests while the suite had grown past 1400"). It slipped through because that check's regex only matches the English words "tests"/"test cases" — "630 項測試" is the same claim in Chinese. Removed the stale count and widened the regex to also catch the CJK phrasing, so this doesn't silently recur.

Test plan

  • node scripts/check-doc-claims.mjs — all 32 checks pass, including the now-widened "READMEs state no hardcoded test count" check
  • Code-fence balance verified in both edited files (60/60, even) — a stray fence would silently break every section after it
  • Heading structure now matches across all three files: Example Usage → Recipes (3 subsections) → Unlock Smart Mode
  • Every local link/path referenced already resolves in git (verified separately while auditing README.md itself)

…ync with English

Three real gaps found by comparing all three READMEs section by
section, none caught by check-doc-claims.mjs since it checks facts,
not translation parity:

- Both translations were missing the entire "Recipes" section (three
  worked examples) that exists in README.md — added, translated to
  match each file's established terminology and register.
- Both translations had reduced the "Conflict Detection" Smart
  Feature to one generic sentence, while English carries three
  sentences of real detail (the command, the review workflow, the
  causality guarantee) — expanded to match.
- README.zh-TW.md's Contributing section hardcoded "630 項測試" next
  to `npm test`, the exact stale-count problem check-doc-claims.mjs's
  test-count guard exists to prevent — just phrased in Chinese, so the
  English-only regex never saw it. Removed, and the regex now also
  matches the CJK phrasing.
@kevintseng
kevintseng merged commit 62ff843 into main Aug 24, 2026
13 checks passed
@kevintseng
kevintseng deleted the fix/readme-i18n-parity branch August 24, 2026 08:28
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