Skip to content

docs(readme): promotional rewrite + 8-language i18n coverage#456

Merged
coseto6125 merged 1 commit into
mainfrom
docs/readme-promo-i18n
May 25, 2026
Merged

docs(readme): promotional rewrite + 8-language i18n coverage#456
coseto6125 merged 1 commit into
mainfrom
docs/readme-promo-i18n

Conversation

@coseto6125
Copy link
Copy Markdown
Owner

Rewrites the main README around a single sharp positioning — a code-intelligence graph built for AI agents, not humans — and lands full i18n parity with the language set introduced in #236.

What changed

English README.md — promotional rewrite

  • New hero: tagline + stat badges (cold index / query latency / languages / license / Rust / early-release status) + 9-entry language switcher.
  • Opens with three concrete agent failure modes (token waste / broken refactors / hallucinated deps), distilled into a problem→answer table.
  • Design principles tied to mechanisms (mmap, rkyv, BlindSpot), not adjectives.
  • All benchmark tables, CLI surface, peer-sync, provable-verdicts, integration matrix, and the honest release-status caveat are preserved verbatim — no fabricated numbers.
  • Star-history chart moved to the bottom so the first scroll is pure value.

i18n — 8 languages under docs/readme_i18n/ (matching #236)

  • zh-TW rewritten; new: zh-CN, ja, ko, es, pt-BR, ru, hi.
  • Each: identical structure, 8-language switcher with correct current-language marker, fixed ../ / ../../ relative link targets, localized number formats where idiomatic (pt-BR 22.645 / 2,6 s).

How the final version was chosen

Iterated 20 variants across 5 design routes (pain-point table · minimalist-hardcore · narrative · visual-dense · balanced-hybrid), then ranked with 10 evaluation passes — hook, scannability, technical credibility, differentiation, fact-check, link-integrity, visual design, completeness, newcomer-conversion, and a holistic deciding vote. Winner: balanced-hybrid v20, with the Opus reviewer's honest-improvement notes applied.

Verification

  • All 9 files: 396 lines, 6 shields badges, valid MCP JSON block, no stale ./ paths in i18n files.
  • Query-latency figure unified to <175 ms (measured 174.2 ms worst case) across hero / badge / vs-GitNexus table — fixes the prior <170/<150 mismatch.
  • Every internal link target verified to exist on disk (main ./ paths and i18n ..//../../ paths).
  • Docs-only; no FOLLOWUPS entries opened or resolved.

Rewrite the main README around a single positioning — a code-intelligence
graph built for AI agents, not humans. New hero (tagline + stat badges +
language switcher), a three-failure-mode opening (token waste / broken
refactors / hallucinated deps) distilled into a problem→answer table, and
design principles tied to mechanisms (mmap, rkyv, BlindSpot). All benchmark
numbers, CLI surface, and the honest release-status caveat are preserved.

Add full i18n parity with PR #236's language set: zh-TW (rewritten), plus new
zh-CN, ja, ko, es, pt-BR, ru, hi under docs/readme_i18n/. Each carries the
8-language switcher, correct ../ / ../../ relative link targets, localized
number formats where idiomatic (pt-BR 22.645 / 2,6 s), and identical
structure to the English source.

Final English version selected by iterating 20 variants across 5 design
routes, then ranking with 10 evaluation passes (hook / scannability /
credibility / differentiation / fact-check / link-integrity / visual /
completeness / newcomer-conversion / holistic). Winner: balanced-hybrid v20.

The query-latency figure is unified to <175 ms (the measured 174.2 ms worst
case) across hero, badge, and the vs-GitNexus table — fixing the prior
<170/<150 ms mismatch.
@coseto6125 coseto6125 enabled auto-merge (squash) May 25, 2026 19:00
@coseto6125 coseto6125 added the merge-queue Opt-in to Mergify merge queue label May 25, 2026
@github-actions
Copy link
Copy Markdown
Contributor

ecp impact cache (0 symbols) — internal, used by ecp dev pr-analyze

[]

@github-actions github-actions Bot added the ecp:risk-low ecp signal label May 25, 2026
@coseto6125 coseto6125 merged commit 516faba into main May 25, 2026
18 checks passed
@coseto6125 coseto6125 deleted the docs/readme-promo-i18n branch May 25, 2026 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ecp:risk-low ecp signal merge-queue Opt-in to Mergify merge queue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant