[PR #1704] docs(website): add reproducible starter demos #4767

New issue

Open

opened 2026-10-31 00:54:50 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 00:54:50 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/1704
Author: @014-code
Created: 10/11/2026
Status: 🔄 Open

Base: main ← Head: docs/issue-778-demo-portfolio

📝 Commits (7)

42c01fd docs(website): add reproducible starter demos
7c30d2c docs(website): clarify reproducible demo steps
84bd1e6 docs(website): include the Windows browser verifier native prerequisite
41ac317 fix(demos): document prerequisites and verify captures
7bb2ee0 style(docs): format reproducible demo page
58d43f8 fix(docs): sync reproducible demo translations
8b3aded fix(verify): restore demo and agent fixture checks

📊 Changes

48 files changed (+10851 additions, -752 deletions)

View changed files

📝 README.md (+3 -2)
📝 docs/readme/README_ar.md (+3 -1)
📝 docs/readme/README_de.md (+3 -1)
📝 docs/readme/README_el.md (+2 -2)
📝 docs/readme/README_es.md (+3 -1)
📝 docs/readme/README_fa.md (+3 -1)
📝 docs/readme/README_fr.md (+3 -1)
📝 docs/readme/README_id.md (+3 -1)
📝 docs/readme/README_it.md (+3 -1)
📝 docs/readme/README_ja.md (+3 -1)
📝 docs/readme/README_ko.md (+3 -1)
📝 docs/readme/README_pl.md (+3 -1)
📝 docs/readme/README_pt-BR.md (+3 -1)
📝 docs/readme/README_ru.md (+3 -1)
📝 docs/readme/README_th.md (+3 -1)
📝 docs/readme/README_tr.md (+3 -1)
📝 docs/readme/README_uk.md (+3 -1)
📝 docs/readme/README_vi.md (+3 -1)
📝 docs/readme/README_zh-TW.md (+3 -1)
📝 docs/readme/README_zh.md (+3 -1)

...and 28 more files

📄 Description

Summary

Add a README-linked D01-D03 demo portfolio and record what was actually reproduced for issue #778. Refs #778.

Problem and expected behavior

REA already has source-owned examples and verifier lanes, but new users need a compact path from an analyst question to a checked answer across JavaScript/Electron, native analysis and browser behavior. The page distinguishes verified results from provider, agent and measurement gaps so this PR does not imply that issue #778 is complete.

Change and scope

D01 documents the six-file Electron Notes fixture, its CLI analysis and feature trace, the renderer.js -> preload.js -> main.js -> csv.js data flow, the CSV header and the static-analysis limits. The agent evaluation verifier now expects the analysis, feature trace and semantic query sequence.
D02 documents fixture generation and integrity checks, Ghidra CLI/MCP reproduction steps and the required close_binary cleanup. The local Windows host lacked a C compiler and configured Ghidra, IDA or Hopper, so no native result is claimed.
D03 adds a deterministic loopback page with baseline and changed results. The real-browser verifier captures both through the public CLI and compares them with compare-web-captures, asserting aligned steps, a changed result and a DOM difference.
Link the new public page from the README and guide hub. Add a separate evidence record for digests, run IDs, cleanup, blockers and unmeasured resource costs.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation and verifier fixtures only.
CLI and MCP/tool-catalog contract: none; the verifier exercises existing public commands.
Provider, bridge, target-format, or platform compatibility: no provider behavior changed. D03 uses the real Chrome provider; D02 provider execution remains unavailable locally.
Evidence, artifact, provenance, or reconstruction contract: no contract change; the page distinguishes static evidence, real browser captures, unknowns and unverified claims.
Process execution, authorization, cleanup, or containment impact: D03 launches only the source-owned loopback fixture; the verifier terminates its owned Chrome processes and removes profiles and comparison inputs.
Generated metadata, package, or installation impact: none.

Evidence and regression coverage

Tests added or updated: extend the agent experience scenario and real-browser verifier for D01/D03; the D03 check requires real CLI captures, aligned comparison status changed and a changed DOM artifact.
Base reproduction or other evidence: source-backed D01 CLI Evidence and complete feature trace; D03 real Chrome capture and CLI comparison, run b8b2d376-d5a4-495a-b558-dedfc0884d1d.
User-visible output: baseline Exported 2 notes, changed Exported 3 notes, one changed DOM artifact.
Remaining proof gaps: no real D01 agent transcript, no D02 native-provider result, no walkthrough recording or clean-user setup run, and no measured time/CPU/RSS/disk budget. These are stated on the page and in the evidence record.

Validation performed

npm run build:cached - passed as part of verify:browser.
npm run check:fast - passed.
npm run verify:windows-native:artifact - passed for Windows x64, package 6.4.0.
npm run verify:browser - passed with Node.js 24.18.0, npm 11.16.0 and Chrome 154.0.8037.99; run ID above.
python scripts/website.py check - passed: 20 HTML pages, 437 local references, metadata/sitemap checks and 7 maintenance tests.
Scoped oxfmt --check on all 9 changed files and git diff --check - passed. Full-repository npm run format:check flags even unchanged CONTRIBUTING.md in this Windows checkout with core.autocrlf=true; the changed files pass the scoped check.
Pre-commit format/lint hooks and pre-push check:fast - passed.

Compatibility, safety, and release

Breaking changes or migration steps: none.
Real Hopper/Ghidra, browser, or OS coverage: real Chrome on Windows; no local Ghidra/IDA/Hopper run.
Package or release metadata impact: none.
Security, privacy, process, or containment review: fixture traffic is loopback-only; temporary comparison inputs and provider-owned browser resources were cleaned up. No external application or private target was used.

_{🔄 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/1704 **Author:** [@014-code](https://github.com/014-code) **Created:** 10/11/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/issue-778-demo-portfolio` --- ### 📝 Commits (7) - [`42c01fd`](https://github.com/morluto/rea/commit/42c01fd350ec6ad34888513d4341757741969290) docs(website): add reproducible starter demos - [`7c30d2c`](https://github.com/morluto/rea/commit/7c30d2c09e26105cbbd8841bc68cc29840ae5a80) docs(website): clarify reproducible demo steps - [`84bd1e6`](https://github.com/morluto/rea/commit/84bd1e6f99c74a944b29d97e91e3e822dd7aed69) docs(website): include the Windows browser verifier native prerequisite - [`41ac317`](https://github.com/morluto/rea/commit/41ac317b3b9d9ba3acbbbb6a7f5a60ba2f35053f) fix(demos): document prerequisites and verify captures - [`7bb2ee0`](https://github.com/morluto/rea/commit/7bb2ee026d52472538fd3e4bdc1a9f8a6245fe49) style(docs): format reproducible demo page - [`58d43f8`](https://github.com/morluto/rea/commit/58d43f8849a439fa681fec00cb904cd79d91719c) fix(docs): sync reproducible demo translations - [`8b3aded`](https://github.com/morluto/rea/commit/8b3adedae81897e05067e0206e930fc5ffa9ea61) fix(verify): restore demo and agent fixture checks ### 📊 Changes **48 files changed** (+10851 additions, -752 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+3 -2) 📝 `docs/readme/README_ar.md` (+3 -1) 📝 `docs/readme/README_de.md` (+3 -1) 📝 `docs/readme/README_el.md` (+2 -2) 📝 `docs/readme/README_es.md` (+3 -1) 📝 `docs/readme/README_fa.md` (+3 -1) 📝 `docs/readme/README_fr.md` (+3 -1) 📝 `docs/readme/README_id.md` (+3 -1) 📝 `docs/readme/README_it.md` (+3 -1) 📝 `docs/readme/README_ja.md` (+3 -1) 📝 `docs/readme/README_ko.md` (+3 -1) 📝 `docs/readme/README_pl.md` (+3 -1) 📝 `docs/readme/README_pt-BR.md` (+3 -1) 📝 `docs/readme/README_ru.md` (+3 -1) 📝 `docs/readme/README_th.md` (+3 -1) 📝 `docs/readme/README_tr.md` (+3 -1) 📝 `docs/readme/README_uk.md` (+3 -1) 📝 `docs/readme/README_vi.md` (+3 -1) 📝 `docs/readme/README_zh-TW.md` (+3 -1) 📝 `docs/readme/README_zh.md` (+3 -1) _...and 28 more files_ </details> ### 📄 Description ## Summary Add a README-linked D01-D03 demo portfolio and record what was actually reproduced for issue #778. Refs #778. ## Problem and expected behavior REA already has source-owned examples and verifier lanes, but new users need a compact path from an analyst question to a checked answer across JavaScript/Electron, native analysis and browser behavior. The page distinguishes verified results from provider, agent and measurement gaps so this PR does not imply that issue #778 is complete. ## Change and scope - D01 documents the six-file Electron Notes fixture, its CLI analysis and feature trace, the `renderer.js` -> `preload.js` -> `main.js` -> `csv.js` data flow, the CSV header and the static-analysis limits. The agent evaluation verifier now expects the analysis, feature trace and semantic query sequence. - D02 documents fixture generation and integrity checks, Ghidra CLI/MCP reproduction steps and the required `close_binary` cleanup. The local Windows host lacked a C compiler and configured Ghidra, IDA or Hopper, so no native result is claimed. - D03 adds a deterministic loopback page with baseline and changed results. The real-browser verifier captures both through the public CLI and compares them with `compare-web-captures`, asserting aligned steps, a changed result and a DOM difference. - Link the new public page from the README and guide hub. Add a separate evidence record for digests, run IDs, cleanup, blockers and unmeasured resource costs. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation and verifier fixtures only. - CLI and MCP/tool-catalog contract: none; the verifier exercises existing public commands. - Provider, bridge, target-format, or platform compatibility: no provider behavior changed. D03 uses the real Chrome provider; D02 provider execution remains unavailable locally. - Evidence, artifact, provenance, or reconstruction contract: no contract change; the page distinguishes static evidence, real browser captures, unknowns and unverified claims. - Process execution, authorization, cleanup, or containment impact: D03 launches only the source-owned loopback fixture; the verifier terminates its owned Chrome processes and removes profiles and comparison inputs. - Generated metadata, package, or installation impact: none. ## Evidence and regression coverage - Tests added or updated: extend the agent experience scenario and real-browser verifier for D01/D03; the D03 check requires real CLI captures, aligned comparison status `changed` and a changed DOM artifact. - Base reproduction or other evidence: source-backed D01 CLI Evidence and complete feature trace; D03 real Chrome capture and CLI comparison, run `b8b2d376-d5a4-495a-b558-dedfc0884d1d`. - User-visible output: baseline `Exported 2 notes`, changed `Exported 3 notes`, one changed DOM artifact. - Remaining proof gaps: no real D01 agent transcript, no D02 native-provider result, no walkthrough recording or clean-user setup run, and no measured time/CPU/RSS/disk budget. These are stated on the page and in the evidence record. ## Validation performed - `npm run build:cached` - passed as part of `verify:browser`. - `npm run check:fast` - passed. - `npm run verify:windows-native:artifact` - passed for Windows x64, package 6.4.0. - `npm run verify:browser` - passed with Node.js 24.18.0, npm 11.16.0 and Chrome 154.0.8037.99; run ID above. - `python scripts/website.py check` - passed: 20 HTML pages, 437 local references, metadata/sitemap checks and 7 maintenance tests. - Scoped `oxfmt --check` on all 9 changed files and `git diff --check` - passed. Full-repository `npm run format:check` flags even unchanged `CONTRIBUTING.md` in this Windows checkout with `core.autocrlf=true`; the changed files pass the scoped check. - Pre-commit format/lint hooks and pre-push `check:fast` - passed. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: real Chrome on Windows; no local Ghidra/IDA/Hopper run. - Package or release metadata impact: none. - Security, privacy, process, or containment review: fixture traffic is loopback-only; temporary comparison inputs and provider-owned browser resources were cleaned up. No external application or private target was used. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-31 00:54:50 +00:00

bsakaguchi referenced this issue

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

[PR #4767] [MERGED] docs(installation): list every engine accepted by doctor --provider #6400

bsakaguchi referenced this issue

2026-11-01 21:10:54 +00:00

[GH-ISSUE #3795] [Tracker] Open documentation issues and pull requests (October 2026) #1468