morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #1121] [CLOSED] docs(zh): restructure README_zh against the post-1043 English baseline #2666

New issue

Closed

opened 2026-10-17 21:08:49 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-17 21:08:49 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/1121
Author: @BaaRai
Created: 10/8/2026
Status: ❌ Closed

Base: main ← Head: docs/readme-zh-post-1043-baseline

📝 Commits (1)

3982e5e docs(zh): restructure README_zh against the post-1043 English baseline

📊 Changes

1 file changed (+157 additions, -187 deletions)

View changed files

📝 README_zh.md (+157 -187)

📄 Description

Summary

Restructures README_zh.md to follow the rewritten English README from #1043 (quick start, how REA works, analyzable targets, the three showcases, FAQ, documentation, contributing), replacing the pre-rewrite section layout with natural zh-CN prose. Helps #958 (Chinese claimed in the issue).

Problem and expected behavior

The English README was rewritten in #1043 into a shorter structure, but README_zh.md still followed the old layout (27 sections versus the new 20), so Chinese readers got stale positioning, no Notion/TH04 showcases, no update instructions, and old quick-start steps. Expected: the Chinese README mirrors the current English baseline while staying natural and clear, per the unblocking comment in #958.

Change and scope

Full restructure and retranslation against the current README.md: same section order, same quick-nav, the capability table, all three showcases, the FAQ, and the update flow.
Keeps what the docs-facts checker requires translations to carry: the full supported-client list (Claude Code through VS Code) and the tool-family inventory table with the catalog counts, now placed as a subsection under Documentation.
Preserves the current-status and choosing-a-deep-analysis-provider anchor ids used by inbound links, translates badge and image alt text, and keeps every relative and absolute link identical to the English baseline.
Not included: changes to other languages, website content, or any code.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation only (README_zh.md).
CLI and MCP/tool-catalog contract: none; the tool-family table restates the current generated catalog.
Provider, bridge, target-format, or platform compatibility: none.
Evidence, artifact, provenance, or reconstruction contract: none.
Process execution, authorization, cleanup, or containment impact: none.
Generated metadata: not applicable; docs/public/product-catalog.json is untouched and its facts are restated, not changed.

Evidence and regression coverage

Tests added or updated: none (docs-only).
Base reproduction or other evidence: npm run docs:check fails on the base revision for this change's invariants when the client list or tool-family table is absent; it passes with this change. npm run check:fast passes.
Scripted parity check against README.md: every relative target exists on disk, all in-page anchors resolve to generated heading anchors, all 12 setup-client display names present, heading structure matches the English baseline.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/1121 **Author:** [@BaaRai](https://github.com/BaaRai) **Created:** 10/8/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/readme-zh-post-1043-baseline` --- ### 📝 Commits (1) - [`3982e5e`](https://github.com/morluto/rea/commit/3982e5ed1c69b5fd060d9aec3b60e94b7afeb49a) docs(zh): restructure README_zh against the post-1043 English baseline ### 📊 Changes **1 file changed** (+157 additions, -187 deletions) <details> <summary>View changed files</summary> 📝 `README_zh.md` (+157 -187) </details> ### 📄 Description ## Summary Restructures README_zh.md to follow the rewritten English README from #1043 (quick start, how REA works, analyzable targets, the three showcases, FAQ, documentation, contributing), replacing the pre-rewrite section layout with natural zh-CN prose. Helps #958 (Chinese claimed in the issue). ## Problem and expected behavior The English README was rewritten in #1043 into a shorter structure, but README_zh.md still followed the old layout (27 sections versus the new 20), so Chinese readers got stale positioning, no Notion/TH04 showcases, no update instructions, and old quick-start steps. Expected: the Chinese README mirrors the current English baseline while staying natural and clear, per the unblocking comment in #958. ## Change and scope - Full restructure and retranslation against the current README.md: same section order, same quick-nav, the capability table, all three showcases, the FAQ, and the update flow. - Keeps what the docs-facts checker requires translations to carry: the full supported-client list (Claude Code through VS Code) and the tool-family inventory table with the catalog counts, now placed as a subsection under Documentation. - Preserves the `current-status` and `choosing-a-deep-analysis-provider` anchor ids used by inbound links, translates badge and image alt text, and keeps every relative and absolute link identical to the English baseline. - Not included: changes to other languages, website content, or any code. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only (README_zh.md). - CLI and MCP/tool-catalog contract: none; the tool-family table restates the current generated catalog. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Process execution, authorization, cleanup, or containment impact: none. - Generated metadata: not applicable; docs/public/product-catalog.json is untouched and its facts are restated, not changed. ## Evidence and regression coverage - Tests added or updated: none (docs-only). - Base reproduction or other evidence: `npm run docs:check` fails on the base revision for this change's invariants when the client list or tool-family table is absent; it passes with this change. `npm run check:fast` passes. - Scripted parity check against README.md: every relative target exists on disk, all in-page anchors resolve to generated heading anchors, all 12 setup-client display names present, heading structure matches the English baseline. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-17 21:08:49 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-10-31 01:05:39 +00:00

[PR #2686] [MERGED] fix(setup): treat empty DSH_HOME as unset #5311

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#2666

No description provided.

Rows
Columns