[PR #930] [MERGED] docs: add website and showcase links to READMEs #2356

Closed
opened 2026-10-16 21:17:46 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/930
Author: @N0zoM1z0
Created: 10/7/2026
Status: ✅ Merged
Merged: 10/7/2026
Merged by: @N0zoM1z0

Base: main ← Head: docs/website-readme


📝 Commits (1)

  • 931831f docs: add prominent website and showcase links to READMEs

📊 Changes

5 files changed (+11 additions, -1 deletions)

View changed files

📝 README.md (+3 -1)
📝 README_ar.md (+2 -0)
📝 README_ja.md (+2 -0)
📝 README_ko.md (+2 -0)
📝 README_zh.md (+2 -0)

📄 Description

Summary

Give repository readers direct access to the REA website, worked guides, and DX-Ball showcase from the top of every README.

Problem and expected behavior

The English README called the homepage “Documentation,” and the translated READMEs had no website navigation. Readers should be able to find the introduction and examples before scrolling through setup and reference material. This is a focused documentation improvement; there is no linked issue.

Change and scope

Add a separate bold Website · Guides · DX-Ball showcase row above the existing README section navigation. Translate the link labels in the Chinese, Japanese, Korean, and Arabic READMEs, noting that the site is in English. Keep the existing section links.

Contract and boundary impact

The presentation owner is the root README navigation. CLI/MCP contracts, providers, platform support, Evidence, process lifecycle, generated metadata, packaging, and installation: none.

Evidence and regression coverage

Inspected the five-file diff and fetched all three published destinations; each returned HTTP 200 with the expected page title. No tests were added for Markdown link changes. CLI/MCP output and evidence-bearing claim changes: not applicable.

Validation performed

  • npm run check:fast — passed on the rebased branch.
  • oxfmt --check README.md README_zh.md README_ja.md README_ko.md README_ar.md — passed.
  • git diff --check origin/main...HEAD — passed.
  • Python HTTP checks of the homepage, /guides/, and /showcase/dx-ball/ — all HTTP 200.

Compatibility, safety, and release

Breaking changes, migration, package/release metadata, and security/process impact: none. Real Hopper/Ghidra workflows were not run; this change only adds README links. The website's publishing workflow is unchanged.

Review checklist

  • One focused outcome; conventional PR title.
  • Final diff contains only the README navigation changes.
  • Link destinations and formatting checked.
  • Contract, generated metadata, and runtime tests are not applicable to this documentation change.

🔄 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/930 **Author:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Created:** 10/7/2026 **Status:** ✅ Merged **Merged:** 10/7/2026 **Merged by:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Base:** `main` ← **Head:** `docs/website-readme` --- ### 📝 Commits (1) - [`931831f`](https://github.com/morluto/rea/commit/931831f4e88ad8b8c2f04cbf5cc46e2bb90b8a7c) docs: add prominent website and showcase links to READMEs ### 📊 Changes **5 files changed** (+11 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+3 -1) 📝 `README_ar.md` (+2 -0) 📝 `README_ja.md` (+2 -0) 📝 `README_ko.md` (+2 -0) 📝 `README_zh.md` (+2 -0) </details> ### 📄 Description ## Summary Give repository readers direct access to the REA website, worked guides, and DX-Ball showcase from the top of every README. ## Problem and expected behavior The English README called the homepage “Documentation,” and the translated READMEs had no website navigation. Readers should be able to find the introduction and examples before scrolling through setup and reference material. This is a focused documentation improvement; there is no linked issue. ## Change and scope Add a separate bold `Website · Guides · DX-Ball showcase` row above the existing README section navigation. Translate the link labels in the Chinese, Japanese, Korean, and Arabic READMEs, noting that the site is in English. Keep the existing section links. ## Contract and boundary impact The presentation owner is the root README navigation. CLI/MCP contracts, providers, platform support, Evidence, process lifecycle, generated metadata, packaging, and installation: none. ## Evidence and regression coverage Inspected the five-file diff and fetched all three published destinations; each returned HTTP 200 with the expected page title. No tests were added for Markdown link changes. CLI/MCP output and evidence-bearing claim changes: not applicable. ## Validation performed - `npm run check:fast` — passed on the rebased branch. - `oxfmt --check README.md README_zh.md README_ja.md README_ko.md README_ar.md` — passed. - `git diff --check origin/main...HEAD` — passed. - Python HTTP checks of the homepage, `/guides/`, and `/showcase/dx-ball/` — all HTTP 200. ## Compatibility, safety, and release Breaking changes, migration, package/release metadata, and security/process impact: none. Real Hopper/Ghidra workflows were not run; this change only adds README links. The website's publishing workflow is unchanged. ## Review checklist - [x] One focused outcome; conventional PR title. - [x] Final diff contains only the README navigation changes. - [x] Link destinations and formatting checked. - [x] Contract, generated metadata, and runtime tests are not applicable to this documentation change. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-16 21:17:46 +00:00
Sign in to join this conversation.
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#2356
No description provided.