Skip to content

docs: English versions of pitfalls, how-it-works and benchmarks - #18

Merged
korexil merged 1 commit into
mainfrom
docs-en
Oct 16, 2026
Merged

korexil merged 1 commit into
mainfrom
docs-en

Conversation

@korexil

@korexil korexil commented Oct 16, 2026

Copy link
Copy Markdown
Owner

The deeper docs were Chinese only, so English readers who found the README had nothing to follow and English searches had nothing to match.

  • docs/pitfalls.en.md, docs/how-it-works.en.md, docs/benchmarks.en.md, translated faithfully: numbers, item numbers, tables, commands and error messages unchanged; qualifiers (estimated, not profiled, one machine, n runs) kept. Pitfall openings are phrased as the symptom people would search for. #29 also gives the English Windows error text; the quoted prompts in Harden the C bridge and the hand-off; add tests and CI #1 and README: demo video #6 note that they are translations.
  • The Chinese originals get a language switch line; README.en.md links to the English versions.
  • Internal links and anchors checked against GitHub's heading rules.

@korexil
korexil merged commit 335785f into main Oct 16, 2026
5 checks passed
@korexil
korexil deleted the docs-en branch October 16, 2026 06:05
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