Skip to content

docs(i18n): copy-edit the English to newspaper style - #39

Merged
eaitbrahim merged 2 commits into
mainfrom
i18n/en-newspaper-style
Aug 20, 2026
Merged

docs(i18n): copy-edit the English to newspaper style#39
eaitbrahim merged 2 commits into
mainfrom
i18n/en-newspaper-style

Conversation

@eaitbrahim

Copy link
Copy Markdown
Contributor

Closes #37.

Scope note, up front. The English was not in the state the Arabic was in
#34. It is authored, not translated — no broken words, no factual bugs, no
mistranslations. What it had was a copy-editing backlog. So this is a
copy-edit, not a rewrite: the register stays, and no headline or honest-framing
sentence was softened.

Fixed

A number with no noun. features.ts: "the same rules on ONE_HOUR bars fire
49.4". The unit — signals per asset-year — sat in the previous clause and never
came back. It read as a typo.

Six sentences ran 40 to 54 words. The longest, install.ts's code-signing
paragraph, is now four sentences. Nothing over 38 words remains, and what is
left is parallel enumeration where the length is doing work.

Dash density. home.ts's honest-result paragraph carried four em dashes;
compare.ts's footnote carried three. One dash-set aside per sentence now.

Quote marks. about.ts used curly quotes for “open source” and escaped
straight quotes for "keel trading", three answers apart. community.ts was
straight throughout. All curly now.

Brand capitalisation. home.ts's <title> read "Keel: Open-Source Shariah
Compliance Engine for Crypto" — the only English string capitalising the brand.

A CLI literal in two forms. "a GO-LIVE / TRAIN-MORE report", then "tell you
TRAIN MORE", one sentence apart, in features.ts and install.ts.

Unglossed jargon on the pages where a search visitor first meets it:
PBO/CSCV is now expanded as the probability of backtest overfitting computed
by combinatorially symmetric cross-validation; bp is basis points; "per leg"
is "on each side of a trade"; "fails closed" gets a clause on the home page.

SEO. compare.ts's meta description was 177 characters and would have
truncated. Now 132. Everything else sits between 135 and 157.

Constructions: "Apache-2.0 cannot be un-free'd", "the whole gauntlet
exercised in production", "Venue breadth is deliberately not chased", "Said
upfront so step four is not a surprise", "the tried-vs-used ledger", and
"practised" where every other spelling in the repo is US.

Style sheet

CONTRIBUTING.md gains a Prose style section — dash limit, sentence length,
gloss-per-page, figures, brand case, quote marks, CLI literals, spelling, meta
length. The point is that the next page follows the rules rather than
re-deriving them.

Three French strings, despite French being deferred

The home <title> brand capitalisation, the TRAIN-MORE CLI literal, and the
PBO/CSCV expansion. These are cross-cutting consistency rather than a French
style pass, and leaving them inconsistent after fixing English and Arabic would
have been worse. The equivalent Arabic gloss was added as well, so rev and
translatedFromRev move together and no page shows a spurious stale banner.

French prose itself is still untouched and still wants its own pass.

Verification

🤖 Generated with Claude Code

https://claude.ai/code/session_01EURzVpngXDN1dk9c5FMFhW

eaitbrahim and others added 2 commits August 20, 2026 19:19
A copy-edit, not a rewrite. The register — dry, declarative, honest result
first — is the product's voice and is unchanged; no headline and no
honest-framing sentence was softened.

Fixed:

- features.ts carried a number with no noun: "the same rules on ONE_HOUR bars
  fire 49.4". The unit sat in the previous clause and never came back.
- Six sentences ran 40-54 words. The longest, install.ts's code-signing
  paragraph, is now four sentences.
- home.ts's honest-result paragraph carried four em dashes; compare.ts's
  footnote carried three. One dash-set aside per sentence now.
- about.ts used curly quotes for "open source" and escaped straight quotes for
  "keel trading", three answers apart. community.ts was straight throughout.
- home.ts's <title> was the only English string capitalising the brand.
- "a GO-LIVE / TRAIN-MORE report" then "tell you TRAIN MORE", one sentence
  apart, in two files.
- PBO/CSCV, basis points, "per leg" and "fails closed" were bare on the pages
  where a search visitor first meets them.
- compare.ts's meta description was 177 characters and would have truncated.
- "un-free'd", "the whole gauntlet exercised", "Venue breadth is deliberately
  not chased", "Said upfront so step four is not a surprise", "the
  tried-vs-used ledger", and "practised" against "summarizes" elsewhere.

CONTRIBUTING.md gains a Prose style section so the next page follows the same
rules rather than re-deriving them.

Three French strings changed, despite French being deferred: the brand
capitalisation in the home <title>, the TRAIN-MORE CLI literal, and the
PBO/CSCV expansion. These are cross-cutting consistency, not a French style
pass. The equivalent Arabic gloss was added too, so rev and translatedFromRev
move together and no page shows a spurious stale banner.

Closes #37

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EURzVpngXDN1dk9c5FMFhW
PR #40 merged the French revision first, so all four conflicts landed in the
French blocks: the new French prose against the three cross-cutting fixes this
branch had made there.

Every conflict resolves in favour of the new French. The three consistency
fixes are then re-applied on top, because #40 reintroduced them:

- home.ts — the French <title> capitalised the brand again ("Keel : le moteur
  …"). Lowercased, keeping the French no-break space before the colon.
- home.ts — the PBO/CSCV expansion was dropped. Restored on the new wording.
- install.ts, features.ts — "TRAIN MORE" for the CLI literal, which is
  TRAIN-MORE.

Revisions reconciled so no page shows a spurious stale banner: home fr and
community fr now carry translatedFromRev equal to their English rev. Verified
across all nine pages — every ar and fr translatedFromRev matches its en rev.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EURzVpngXDN1dk9c5FMFhW
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
73.6% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

@eaitbrahim
eaitbrahim merged commit 8c8a727 into main Aug 20, 2026
1 of 2 checks passed
@eaitbrahim
eaitbrahim deleted the i18n/en-newspaper-style branch August 21, 2026 21:50
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.

i18n(en): copy-edit every page's English to newspaper style

1 participant