Skip to content

Write the upgrade guide in English - #303

Merged
gplanchat merged 4 commits into
mainfrom
docs/upgrade-guide-in-english
Sep 7, 2026
Merged

Write the upgrade guide in English#303
gplanchat merged 4 commits into
mainfrom
docs/upgrade-guide-in-english

Conversation

@gplanchat

Copy link
Copy Markdown
Owner

UPGRADE.md, 324 lines, French from top to bottom. It is what a consumer reads when a release
breaks something — the "documentation in every case" half of this repository's own rule.

What is checked, not claimed

  • The eight fenced blocks diff clean, except two comment lines. Extracted from both versions and
    compared in order: composer require, vendor/bin/rector process src, the rector.php sample,
    both bin/console cache:clear, the durable.nexus_handler: … is served by nobody output and the
    tags YAML are what a reader copies, and they are untouched.
  • The two lines that did move are comments inside fences — one // in the rector.php sample,
    one # in the tags YAML — each with the code on its line and its column alignment unchanged. The
    brief named // only; the agent translated the # too and flagged it as a decision rather than
    an oversight. It was right: a French comment left inside an English guide is the visible defect
    the fence rule exists to prevent.
  • Fifteen headings keep their level and order, and ## 0.1.0-alpha8 is byte-identical.
    ## Non publié becomes ## Unreleased, which is prose.
  • Every backticked symbol outside a fence is identical before and after — sorted and compared as
    a multiset. That covers durable.event_store.dbal, Gplanchat\Durable\Store\EventStoreInterface,
    AsActivityHandler, MEMO_KEY_JOURNAL_BOOTSTRAP, and the \BadMethodCallException versus
    BadMethodCallException distinction, which the file makes deliberately and keeps.
  • The three tables were realigned, not left ragged: English is not the width of French. Each now
    has exactly one pipe layout, and each keeps its own separator style.

After this

Nothing French is left outside documentation/ (whose *.fr.md are WA006's own exception),
.cursor/ (another tool's configuration), openspec/ (point-in-time records) and the two
supervised scripts bin/splitsh-publish.sh and bin/prises-check*.sh — the second of which prints
the French you see in the "Stale claims and titles" check.

gplanchat and others added 3 commits September 8, 2026 00:52
`UPGRADE.md` is what a consumer reads when a release breaks something, and the third half of the
repository's own rule: Rector first, a script when Rector cannot, documentation in every case.
Several sections say plainly that Rector cannot help and why — that is the point of the file, and it
survives intact.

Everything a reader copies is byte-identical, and that is checked rather than claimed: the eight
fenced blocks diff clean except two comment lines, the fifteen headings keep their level and order,
`## 0.1.0-alpha8` is untouched, and the set of backticked symbols outside fences — every class,
interface, attribute, constant, service id and config key — is identical before and after.

The two comment lines that did move are inside fences, one `//` in the `rector.php` sample and one
`#` in the tags YAML, each with its code and its column alignment unchanged. A French comment left
in an English guide would be the visible defect the fence rule exists to prevent.

The three tables were realigned rather than left ragged: English is not the width of French, and
each table now has exactly one pipe layout.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@gplanchat
gplanchat enabled auto-merge September 7, 2026 23:13
@gplanchat
gplanchat merged commit 620985d into main Sep 7, 2026
34 checks passed
@gplanchat
gplanchat deleted the docs/upgrade-guide-in-english branch September 7, 2026 23:24
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