[PR #925] [MERGED] docs(website): add worked guides and keep Pages publishing manual #2351

New issue

Closed

opened 2026-10-16 21:17:41 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-16 21:17:41 +00:00

Owner

📋 Pull Request Information

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

Base: main ← Head: feat/website-guides

📝 Commits (4)

9e79aff fix(pages): reserve publishing for the REA website
3314742 docs(website): add worked guides and agent prompt examples
5e3db85 ci(website): check relevant PRs and publish only on demand
7d8899c docs(website): clarify IDA coverage and analysis session lifetime

📊 Changes

25 files changed (+1817 additions, -102 deletions)

View changed files

📝 .github/workflows/pages.yml (+4 -39)
➕ .github/workflows/website-check.yml (+28 -0)
📝 .github/workflows/website-pages.yml (+2 -0)
📝 .oxlintrc.json (+2 -1)
➕ scripts/verify-website.py (+106 -0)
📝 website/README.md (+42 -5)
➕ website/evidence/guide-examples.md (+78 -0)
📝 website/public/assets/main.js (+19 -0)
📝 website/public/assets/styles.css (+227 -0)
➕ website/public/examples/notes-electron/csv.js (+11 -0)
➕ website/public/examples/notes-electron/index.html (+13 -0)
➕ website/public/examples/notes-electron/main.js (+19 -0)
➕ website/public/examples/notes-electron/package.json (+6 -0)
➕ website/public/examples/notes-electron/preload.js (+5 -0)
➕ website/public/examples/notes-electron/renderer.js (+4 -0)
➕ website/public/examples/notes-web/export.js (+24 -0)
➕ website/public/examples/notes-web/index.html (+35 -0)
➕ website/public/examples/notes-web/notes.json (+6 -0)
📝 website/public/get-started/index.html (+99 -39)
➕ website/public/guides/browser/index.html (+339 -0)

...and 5 more files

📄 Description

Readers can now follow native, Electron and browser investigations within the website instead of leaving for long repository guides. Each guide uses a concrete example, a compact flow diagram, an example agent prompt and code or captured results. The DX-Ball sound-pan section also introduces a simple prompt in a restrained terminal card.

The old VitePress workflow previously overwrote the approved website after docs/package updates. It now only builds documentation on manual dispatch and has no publishing job or Pages permissions. website-pages.yml is the sole publisher, stays manual-only on main, and verifies the site before uploading it. Lightweight Website checks run only for PRs changing the site, its verifier or workflow definitions; ordinary source pushes do not trigger Pages publishing or documentation builds.

Validation:

python3 scripts/verify-website.py: nine HTML pages, 132 local references, SVG XML and the sole Pages publisher. Also exercised rejection of a second publisher and a broken HTML fragment.
Parsed workflow YAML and checked manual-only build/deploy triggers and path-filtered PR checks.
Browser checks covered eight routes at both / and /rea/, 46 copy operations, source/CSV downloads, navigation, five viewport widths, keyboard access, reduced motion and the five original assembly-to-C steps.
Released REA 4.1.0 produced the Electron IPC summary and actual browser network/script captures shown in the guides; provenance is in website/evidence/guide-examples.md.
Formatter and changed JavaScript lint passed. The native guide reuses recorded DX-Ball evidence; no new real Hopper/Ghidra verification was run.

After merging, publish explicitly with gh workflow run website-pages.yml --repo morluto/rea --ref main.

_{🔄 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/925 **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:** `feat/website-guides` --- ### 📝 Commits (4) - [`9e79aff`](https://github.com/morluto/rea/commit/9e79affde172a264e6f095c5b2796f1e6bbb1173) fix(pages): reserve publishing for the REA website - [`3314742`](https://github.com/morluto/rea/commit/3314742a173b4eec5fe7114240d3495d720b9b76) docs(website): add worked guides and agent prompt examples - [`5e3db85`](https://github.com/morluto/rea/commit/5e3db85b4d2c648e68b60d2d5655c80a44f92590) ci(website): check relevant PRs and publish only on demand - [`7d8899c`](https://github.com/morluto/rea/commit/7d8899c10b419a7326245be9e627118c26b7f095) docs(website): clarify IDA coverage and analysis session lifetime ### 📊 Changes **25 files changed** (+1817 additions, -102 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/pages.yml` (+4 -39) ➕ `.github/workflows/website-check.yml` (+28 -0) 📝 `.github/workflows/website-pages.yml` (+2 -0) 📝 `.oxlintrc.json` (+2 -1) ➕ `scripts/verify-website.py` (+106 -0) 📝 `website/README.md` (+42 -5) ➕ `website/evidence/guide-examples.md` (+78 -0) 📝 `website/public/assets/main.js` (+19 -0) 📝 `website/public/assets/styles.css` (+227 -0) ➕ `website/public/examples/notes-electron/csv.js` (+11 -0) ➕ `website/public/examples/notes-electron/index.html` (+13 -0) ➕ `website/public/examples/notes-electron/main.js` (+19 -0) ➕ `website/public/examples/notes-electron/package.json` (+6 -0) ➕ `website/public/examples/notes-electron/preload.js` (+5 -0) ➕ `website/public/examples/notes-electron/renderer.js` (+4 -0) ➕ `website/public/examples/notes-web/export.js` (+24 -0) ➕ `website/public/examples/notes-web/index.html` (+35 -0) ➕ `website/public/examples/notes-web/notes.json` (+6 -0) 📝 `website/public/get-started/index.html` (+99 -39) ➕ `website/public/guides/browser/index.html` (+339 -0) _...and 5 more files_ </details> ### 📄 Description Readers can now follow native, Electron and browser investigations within the website instead of leaving for long repository guides. Each guide uses a concrete example, a compact flow diagram, an example agent prompt and code or captured results. The DX-Ball sound-pan section also introduces a simple prompt in a restrained terminal card. The old VitePress workflow previously overwrote the approved website after docs/package updates. It now only builds documentation on manual dispatch and has no publishing job or Pages permissions. `website-pages.yml` is the sole publisher, stays manual-only on `main`, and verifies the site before uploading it. Lightweight Website checks run only for PRs changing the site, its verifier or workflow definitions; ordinary source pushes do not trigger Pages publishing or documentation builds. Validation: - `python3 scripts/verify-website.py`: nine HTML pages, 132 local references, SVG XML and the sole Pages publisher. Also exercised rejection of a second publisher and a broken HTML fragment. - Parsed workflow YAML and checked manual-only build/deploy triggers and path-filtered PR checks. - Browser checks covered eight routes at both `/` and `/rea/`, 46 copy operations, source/CSV downloads, navigation, five viewport widths, keyboard access, reduced motion and the five original assembly-to-C steps. - Released REA 4.1.0 produced the Electron IPC summary and actual browser network/script captures shown in the guides; provenance is in `website/evidence/guide-examples.md`. - Formatter and changed JavaScript lint passed. The native guide reuses recorded DX-Ball evidence; no new real Hopper/Ghidra verification was run. After merging, publish explicitly with `gh workflow run website-pages.yml --repo morluto/rea --ref main`. --- <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:41 +00:00