docs(phase19): README overhaul + 11-language sync (ja/zh-CN/zh-TW/es/fr/ru/uk/hi/ar/fa/he)#91
Merged
clearclown merged 8 commits intomainfrom Apr 26, 2026
Merged
Conversation
Canonical English README updated to Phase 19 Tier C/D reality: - Badges: tests-1192, foundry_test (not legacy forge_test), phase-19_hardened - Status Honesty section: 14 working / 5 scaffolded / 4 not-done - Phase 19 Tier C/D enablers (peer HTTP discovery, forward_chat_to_peer, ProofPolicy=Optional, gated mainnet Makefile) - Project structure now 16 crates (tirami-zkml-bench + tirami-attestation) - Legacy x_forge.cu_cost / /forge/balance strings removed - Docs section reorganized (Vision/Protocol/Security/Developer) All 11 translations re-synced from the canonical English: - ja / zh-CN / zh-TW: delta update, preserving human-polished idioms - es / fr / uk / hi: full rewrite on top of machine-translated baseline - ar / fa / he: RTL-aware with dir="rtl" wrappers for prose, LTR code blocks - ru: clean rewrite (previous version had Phase 1-6 vs 785 tests contradiction) Verification: - grep for legacy forge/balance|x_forge.cu_cost across 11 langs: 0 hits - grep for "1192" or "Phase 19" in each lang README: >= 8 hits each Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR refreshes the project’s public-facing documentation to reflect “Phase 19” reality, and syncs that updated canonical README content across multiple translations (including RTL handling), while also removing legacy Forge-era API strings.
Changes:
- Rewrites/extends the canonical
README.mdwith a “Status Honesty” section, updated Phase/test counts, and revised quick-start/API references. - Propagates the new structure and updated API strings to multiple translated READMEs, adding Phase/test badges and RTL wrappers where applicable.
- Removes legacy
/forge/*andx_forge.*references from the updated docs snippets.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Canonical README overhaul for Phase 19, with new status section, updated quick start, API notes, and ecosystem/docs reorg. |
| docs/translations/zh-TW/README.md | Updates Traditional Chinese translation to match Phase 19 canonical content and removes legacy Forge strings. |
| docs/translations/zh-CN/README.md | Updates Simplified Chinese translation to match Phase 19 canonical content and removes legacy Forge strings. |
| docs/translations/ru/README.md | Rewrites Russian translation to align with Phase 19 content and current test counts. |
| docs/translations/hi/README.md | Updates Hindi translation to align with Phase 19 content and current API strings. |
| docs/translations/he/README.md | Updates Hebrew translation with RTL wrappers and Phase 19 content sync. |
| docs/translations/fr/README.md | Updates French translation to align with Phase 19 content and current API strings. |
| docs/translations/fa/README.md | Updates Persian translation with RTL wrappers and Phase 19 content sync. |
| docs/translations/es/README.md | Updates Spanish translation to align with Phase 19 content and current API strings. |
| docs/translations/ar/README.md | Updates Arabic translation with RTL wrappers and Phase 19 content sync. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
9
to
13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Either provide real URLs (e.g., CI workflow / docs / verify script) or remove the link wrapper and keep them as plain images.
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
|  |
Comment on lines
+9
to
+13
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
These new badges are wrapped in links with empty destinations (]()), which renders as a broken/self-link in Markdown. Please either supply actual target URLs or remove the link wrappers and keep them as plain images.
Suggested change
| []() | |
| []() | |
| []() | |
| []() | |
| []() | |
|  | |
|  | |
|  | |
|  | |
|  |
- CLAUDE.md: fix stale "891 tests / Phase 7 / 785 tests" references to current Phase 19 reality (1,192 Rust + 15 Solidity + 646 forge-mesh + 16 economics SPEC-AUDIT = 1,869 passing). Add Phase 17-19 hardening summary, rename "Working Now (Phase 1-6)" → "Historical foundation", fix x_forge → x_tirami reference, expand Docs list with Phase 18-19 additions (whitepaper, release-readiness, constitution, zkml-strategy, public-api-surface, deployments, SECURITY.md). - docs/launch-phase19.md: public-announcement drafts (HN Show HN, r/LocalLLaMA, r/MachineLearning, X thread) with current tests/phase numbers and a pre-flight checklist. Supersedes the Phase 10 hn-teaser-draft.md. - docs/deploy-base-sepolia.md: step-by-step Base Sepolia testnet deploy walkthrough (prereqs, dry-run, broadcast+verify, post-deploy anchor wiring, stability log). Explicitly re-states the three-gate mainnet refusal. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Real runtime bug found during end-to-end validation: - `dispatch_remote_task` in Phase 18.5-pt3c's peer-forwarding path was parsing the reply for `json["x_forge"]["trm_cost"]`, but Tirami nodes actually return `json["x_tirami"]["trm_cost"]` (renamed in Phase 18.5 but this dispatch path was never updated). When a local worker forwards `/v1/chat/completions` to a peer, the peer's TRM cost is therefore dropped and `remote_cost_trm` falls back to None, forcing the caller onto its local estimate. The unit test mock was also producing `x_forge`, which hid the bug — both now use `x_tirami`. - `scripts/demo-e2e.sh` line 79 extracted `$.x_forge.cu_cost` from the chat response, which the actual response no longer carries. This made the L0 inference step of the canonical demo script crash with a KeyError. Fixed to read `$.x_tirami.trm_cost`. - `scripts/demo.sh` and `examples/demo.sh` were still hard-coded for the pre-rename `forge*` binary and `/v1/forge/*` endpoints. Rewritten to use `./target/release/tirami` and `/v1/tirami/*`. Verification: - `cargo test --workspace` → 1,192 passed, 0 failed (unchanged) - `bash scripts/demo-e2e.sh` → all 7 demo phases green end-to-end (L0 inference, L1 balance/trades/pricing, L2 bank tick + VaR, L4 agora register+find, L3 mind init+improve, Phase 9 A4/A5, Phase 10 Prometheus) - `forge test` on tirami-contracts → 15 passed, 0 failed (unchanged) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The previous framing in Status Honesty ("Not done (required before public
mainnet)" + "Base L2 mainnet deploy" as a pending maintainer task) implied
that the maintainers are operating a mainnet roadmap. They are not.
Corrected stance, applied across:
- README.md (English canonical)
- All 11 translations (ja, zh-CN, zh-TW, es, fr, ru, uk, hi, ar, fa, he)
- CLAUDE.md (internal dev guide)
- docs/launch-phase19.md (HN/Reddit/HN/X drafts + pre-flight FAQ)
- docs/deploy-base-sepolia.md (Mainnet-is-gated section)
Each "Not done" list now contains only: (1) external security audit,
(2) live bug bounty w/ real PGP, (3) 30-day Sepolia + 7-day 10-node
stress test. Mainnet is explicitly moved out of the "Not done by
maintainers" list and into a dedicated paragraph stating that:
- Maintainers do not plan, operate, or track any mainnet deploy.
- The Makefile's 3-gate (AUDIT_CLEARANCE + MULTISIG_OWNER +
i-accept-responsibility) is a self-protective check for any
operator who chooses to deploy, not a maintainer-authorization
switch.
- Since this is MIT OSS, third parties can deploy regardless;
doing so is entirely on their own account, maintainer-uninvolved.
- See SECURITY.md § Secondary Markets.
Tier roadmap in each language also reframed: OSS preview → invited
testnet → open testnet; mainnet is intentionally left to third parties.
No code changes.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ProofPolicy=Optional, gated mainnet deploy).tests-1192_passing,foundry_test-15/15,phase-19_hardened,mainnet-audit_gated./forge/balance,x_forge.cu_costAPI strings across every translation.docs/translations/{ja,zh-CN,zh-TW,es,fr,ru,uk,hi,ar,fa,he}/README.md:ja / zh-CN / zh-TW(human-polished): delta update preserving existing idioms.es / fr / uk / hi(previously machine-translated): full rewrite on top of machine-translated baseline.ar / fa / he(RTL):<div dir="rtl">wrappers for prose, code blocks left LTR for$/curl.ru: complete rewrite — the prior file had a Phase 1-6 header but claimed 785 tests, i.e. broken.Test plan
grep -E 'forge/balance|x_forge\.cu_cost' README.md docs/translations/*/README.md→ 0 matchesfor lang in ja zh-CN zh-TW es fr ru uk hi ar fa he; do grep -cE '1192|Phase 19|phase-19' docs/translations/$lang/README.md; done→ each ≥ 8cargo test --workspace(no change to code — README only)🤖 Generated with Claude Code