[PR #4449] [CLOSED] docs: improve research and tool discovery #6250

New issue

Closed

opened 2026-10-31 01:13:01 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:13:01 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4449
Author: @reacher-z
Created: 10/16/2026
Status: ❌ Closed

Base: main ← Head: codex/research-discovery

📝 Commits (4)

b508c97 docs: improve research and tool discovery
3518e77 docs: reconcile research discovery with current main
b3229d0 fix: remove unused hex record metadata type
f286b80 docs: distinguish JEB CE and licensed startup support

📊 Changes

79 files changed (+9525 additions, -2258 deletions)

View changed files

📝 README.md (+1 -0)
📝 docs/.vitepress/config.ts (+2 -0)
📝 docs/index.md (+3 -0)
➕ docs/mcp-ecosystem.md (+128 -0)
📝 docs/readme/README_ar.md (+2 -0)
📝 docs/readme/README_de.md (+2 -0)
📝 docs/readme/README_el.md (+2 -0)
📝 docs/readme/README_es.md (+2 -0)
📝 docs/readme/README_fa.md (+2 -0)
📝 docs/readme/README_fr.md (+2 -0)
📝 docs/readme/README_id.md (+2 -0)
📝 docs/readme/README_it.md (+2 -0)
📝 docs/readme/README_ja.md (+2 -0)
📝 docs/readme/README_ko.md (+2 -0)
📝 docs/readme/README_ml.md (+2 -0)
📝 docs/readme/README_pl.md (+2 -0)
📝 docs/readme/README_pt-BR.md (+2 -0)
📝 docs/readme/README_ro.md (+2 -0)
📝 docs/readme/README_ru.md (+2 -0)
📝 docs/readme/README_th.md (+2 -0)

...and 59 more files

📄 Description

Summary

Make REA's research references, MCP ecosystem notes, and canonical project identity easier for readers and crawlers to find.

Problem and expected behavior

The public website has page metadata and a sitemap, but lacks structured project identity and a compact agent navigation index. Related papers and MCP implementations are scattered across upstream sites.

Change and scope

Add a six-paper research page, a 30-implementation MCP survey, and an Unreal MCP reference. Link them from docs and website navigation, and synchronize all 22 README translations and website navigation labels.
Generate canonical WebSite / SoftwareSourceCode JSON-LD for indexable pages and llms.txt from indexable English page metadata. Keep drafts and untranslated fallbacks out of these indexes.
Parse script data separately from visible links, while retaining checks for visible URL examples and script asset URLs.
Update the script-language fixture to prepare the actual publish metadata before verification and resolve its temporary root consistently on macOS.

Reconciled with main b594fbc3e. Existing translated text, the new RL-environment guide, FAQ navigation, and upstream verification reports are retained. Generated PO changes synchronize source entries and line references.

Dependency: includes the three-line unused-type cleanup from #7718, which fixes the ordinary Knip failure reproduced on that base. Merge #7718 first; the remaining change is documentation and website maintenance.

Contract and boundary impact

Owners: website artifact preparation and HTML reference parsing; no runtime schema or consumer changes.
CLI/MCP contracts, providers, target authority, and Evidence semantics: unchanged.
Product catalogs and packaged skills remain ignored generated artifacts; no release or installation changes.
Maintainer capability scope decision: not applicable; no new analysis capability or target interaction.

Evidence and regression coverage

Checks cover malformed JSON-LD, incorrect project identity, stale navigation indexes, noindex/language exclusions, visible links versus script data, and script-language metadata. Existing translations were compared with the base and retained in all 22 catalogs.

The JEB review correction keeps the earlier licensed-build startup limitation separate from the verified Linux CE route in the owning provider guide. The linked CE audit qualifies selected native reads; this change does not repeat those engine runs.

The survey records documentation claims at its stated source checkpoint. External MCP servers were not installed or tested, and paper experiments were not reproduced. Metadata does not establish indexing, ranking, or AI citations.

Validation performed

Node 24.22.1 and npm 11.16.0 on macOS arm64; website checks use the pinned Python requirements.

npm run check — passed, including typecheck, format, Knip, module/architecture checks, production reachability analysis, and typed lint. Existing lint warnings and advisory candidates remain.
npm run docs:check — passed, including 9 README consistency tests.
npm run docs:build — passed.
python scripts/website.py check — passed: 27 tests, 485 HTML pages, 34,116 local references; 382 indexable pages and 21 English index entries.
Browser QA — research page and footer checked on desktop and at 390px, with light/dark modes; no horizontal page overflow. Prefix-route behavior is covered by the maintenance suite.
git diff --check origin/main — passed.

Compatibility, safety, and release

No breaking runtime/API changes. The canonical public origin remains rea.tools; publication uses the existing manual website-pages.yml workflow after merge. Untranslated research editions remain labeled English fallbacks with noindex. No production deployment is included in this draft.

Author readiness

Human owner: @reacher-z

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare this PR ready for initial maintainer review.

_{🔄 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/4449 **Author:** [@reacher-z](https://github.com/reacher-z) **Created:** 10/16/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `codex/research-discovery` --- ### 📝 Commits (4) - [`b508c97`](https://github.com/morluto/rea/commit/b508c97740a9eaadae8f7abf6cb63baadf92af29) docs: improve research and tool discovery - [`3518e77`](https://github.com/morluto/rea/commit/3518e7775f715d8b826e368ef95ef6f06c0cfbfd) docs: reconcile research discovery with current main - [`b3229d0`](https://github.com/morluto/rea/commit/b3229d0170c2e28b053cf025b96d9bc200b2c6a1) fix: remove unused hex record metadata type - [`f286b80`](https://github.com/morluto/rea/commit/f286b802cefa801b4e67d20c37014cc850bce274) docs: distinguish JEB CE and licensed startup support ### 📊 Changes **79 files changed** (+9525 additions, -2258 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+1 -0) 📝 `docs/.vitepress/config.ts` (+2 -0) 📝 `docs/index.md` (+3 -0) ➕ `docs/mcp-ecosystem.md` (+128 -0) 📝 `docs/readme/README_ar.md` (+2 -0) 📝 `docs/readme/README_de.md` (+2 -0) 📝 `docs/readme/README_el.md` (+2 -0) 📝 `docs/readme/README_es.md` (+2 -0) 📝 `docs/readme/README_fa.md` (+2 -0) 📝 `docs/readme/README_fr.md` (+2 -0) 📝 `docs/readme/README_id.md` (+2 -0) 📝 `docs/readme/README_it.md` (+2 -0) 📝 `docs/readme/README_ja.md` (+2 -0) 📝 `docs/readme/README_ko.md` (+2 -0) 📝 `docs/readme/README_ml.md` (+2 -0) 📝 `docs/readme/README_pl.md` (+2 -0) 📝 `docs/readme/README_pt-BR.md` (+2 -0) 📝 `docs/readme/README_ro.md` (+2 -0) 📝 `docs/readme/README_ru.md` (+2 -0) 📝 `docs/readme/README_th.md` (+2 -0) _...and 59 more files_ </details> ### 📄 Description ## Summary Make REA's research references, MCP ecosystem notes, and canonical project identity easier for readers and crawlers to find. ## Problem and expected behavior The public website has page metadata and a sitemap, but lacks structured project identity and a compact agent navigation index. Related papers and MCP implementations are scattered across upstream sites. ## Change and scope - Add a six-paper research page, a 30-implementation MCP survey, and an Unreal MCP reference. Link them from docs and website navigation, and synchronize all 22 README translations and website navigation labels. - Generate canonical `WebSite` / `SoftwareSourceCode` JSON-LD for indexable pages and `llms.txt` from indexable English page metadata. Keep drafts and untranslated fallbacks out of these indexes. - Parse script data separately from visible links, while retaining checks for visible URL examples and script asset URLs. - Update the script-language fixture to prepare the actual publish metadata before verification and resolve its temporary root consistently on macOS. Reconciled with main `b594fbc3e`. Existing translated text, the new RL-environment guide, FAQ navigation, and upstream verification reports are retained. Generated PO changes synchronize source entries and line references. **Dependency:** includes the three-line unused-type cleanup from [#7718](https://github.com/morluto/rea/pull/7718), which fixes the ordinary Knip failure reproduced on that base. Merge #7718 first; the remaining change is documentation and website maintenance. ## Contract and boundary impact - Owners: website artifact preparation and HTML reference parsing; no runtime schema or consumer changes. - CLI/MCP contracts, providers, target authority, and Evidence semantics: unchanged. - Product catalogs and packaged skills remain ignored generated artifacts; no release or installation changes. - Maintainer capability scope decision: not applicable; no new analysis capability or target interaction. ## Evidence and regression coverage Checks cover malformed JSON-LD, incorrect project identity, stale navigation indexes, noindex/language exclusions, visible links versus script data, and script-language metadata. Existing translations were compared with the base and retained in all 22 catalogs. The JEB review correction keeps the earlier licensed-build startup limitation separate from the verified Linux CE route in the owning provider guide. The linked CE audit qualifies selected native reads; this change does not repeat those engine runs. The survey records documentation claims at its stated source checkpoint. External MCP servers were not installed or tested, and paper experiments were not reproduced. Metadata does not establish indexing, ranking, or AI citations. ## Validation performed Node 24.22.1 and npm 11.16.0 on macOS arm64; website checks use the pinned Python requirements. - `npm run check` — passed, including typecheck, format, Knip, module/architecture checks, production reachability analysis, and typed lint. Existing lint warnings and advisory candidates remain. - `npm run docs:check` — passed, including 9 README consistency tests. - `npm run docs:build` — passed. - `python scripts/website.py check` — passed: 27 tests, 485 HTML pages, 34,116 local references; 382 indexable pages and 21 English index entries. - Browser QA — research page and footer checked on desktop and at 390px, with light/dark modes; no horizontal page overflow. Prefix-route behavior is covered by the maintenance suite. - `git diff --check origin/main` — passed. ## Compatibility, safety, and release No breaking runtime/API changes. The canonical public origin remains `rea.tools`; publication uses the existing manual `website-pages.yml` workflow after merge. Untranslated research editions remain labeled English fallbacks with noindex. No production deployment is included in this draft. ## Author readiness Human owner: @reacher-z - [ ] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [ ] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [ ] I declare this PR ready for initial maintainer review. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:13:01 +00:00