morluto/rea

Fork 0

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

[PR #2207] [MERGED] docs: correct drift and reorganize English guides #5084

New issue

Closed

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

bsakaguchi commented

2026-10-31 01:03:34 +00:00

Owner

📋 Pull Request Information

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

Base: main ← Head: docs/english-guides-refactor-2156

📝 Commits (1)

bf6f06b docs: correct drift and reorganize English guides

📊 Changes

25 files changed (+2090 additions, -1849 deletions)

View changed files

📝 .agents/skills/reverse-engineer-anything/SKILL.md (+1 -1)
📝 .agents/skills/reverse-engineer-anything/references/native-and-artifacts.md (+9 -9)
📝 docs/.vitepress/config.ts (+6 -4)
📝 docs/binary-diagnostics.md (+3 -1)
📝 docs/browser-observation.md (+9 -1)
📝 docs/cli.md (+1 -1)
➕ docs/client-configuration.md (+225 -0)
➕ docs/client-verification.md (+488 -0)
📝 docs/ghidra-dos.md (+7 -4)
📝 docs/index.md (+20 -0)
📝 docs/installation.md (+243 -434)
📝 docs/javascript-artifact-reconstruction.md (+180 -159)
📝 docs/managed-code-analysis.md (+67 -61)
📝 docs/mcp-contracts.md (+358 -341)
📝 docs/mcp-prompts.md (+6 -0)
📝 docs/native-investigation.md (+179 -124)
📝 docs/process-capture.md (+91 -73)
📝 docs/testing.md (+185 -627)
📝 docs/wasm-artifacts.md (+1 -1)
📝 docs/windows-ghidra-p0.md (+4 -2)

...and 5 more files

📄 Description

Summary

Refs #2156. Correct verified drift in the English guides and put usable workflows before implementation references. Root READMEs, translations, and website/ are outside this PR.

Problem and expected behavior

Several guides describe older behavior: NativeAOT routing, cancellation retention, HAR keys, completion readiness, CDP limits, load-image verification, and large MCP replies. Installation and testing also mix first-use steps with long client-specific records. Readers need accurate instructions, explicit limits and recovery steps, and one owner for repeated rules.

Change and scope

Correct the confirmed claims, broken catalog/WABT links, and Android fixture command. Preserve provider authority, provenance, partial-result recovery, and resource limits.
Reorder installation, testing, MCP, native, JavaScript, managed, and process guides around their tasks. Move client settings and verification records to two linked reference pages; consolidate Hopper analysis guidance in the native guide.
Preserve existing H2 anchors and fenced examples. Add runnable JS summary-to-view, managed inspection, and controlled process recipes.
Synchronize one Ghidra capability description with admitted raw imports. Increment the authored skill to version 40 and regenerate its tracked metadata.
Rebase onto 10400fdb; retain the newly merged inventory/WASM view instructions, first-call WASM summaries, Frida guide/verification entries, and current six-shard CI rules.

Contract and boundary impact

Semantic owner: authored documentation and skill references; the only runtime change is descriptive capability text.
CLI/MCP contracts: no operation, schema, request, or result-shape changes.
Providers/platforms: no authority or admission changes; Windows P0 remains without mutation authority.
Evidence/provenance: unchanged; documentation distinguishes retained complete records, partial coverage, derived views, and unknowns.
Execution/authorization/cleanup: unchanged.
Generated/package impact: skill version 40; ignored catalogs and packaged skills regenerated for verification, not committed.

Evidence and regression coverage

No tests are added or weakened. Existing focused checks cover doc/catalog consistency, prompt MCP, HAR, response budgets, raw/COM interpretation, Windows capability semantics, and newly merged inventory/WASM views.

Real isolated Linux CLI/MCP probes verified Ghidra cold/warm completion and raw/COM attestation, NativeAOT symbols/type recovery, HAR own-key preservation and duplicate refusal, cancellation with partial retention/recovery, large ELF delivery with both endpoint budgets, native field truncation, and the new recipes. Real Chrome verified the 64 MiB CDP limit using a smaller escaped console payload after a large DOM probe hit our memory guard and was stopped.

Observed, derived, and inferred claims remain distinguishable.
Artifact identity, provenance, and failed attempts remain preserved.
Unsupported, incomplete, unavailable, and uncertain outcomes remain visible.

Validation performed

Post-rebase validation against the final source tree:

npm run docs:check -- --concurrency=2 — passed; refreshed runtime/skill/catalog artifacts.
npm run test:focused with 13 exact file paths — 77 tests passed, including the browser probe lifecycle regression.
npm run check:fast -- --concurrency=2 — typecheck, lint, and module boundaries passed.
npm run docs:build — production pages and dead-link validation passed.
Exact-path oxfmt --check --threads=2 and git diff --check — passed.
Seven guides' original H2 headings, 230 local links, and 23 JSON fences — passed.
Real documented CLI/MCP recipe probes and HAR/cancellation/recovery probes — passed again using the rebased runtime.

The broader real Ghidra, NativeAOT, ELF-budget, native-field, and Chrome probes above passed before this rebase; their affected implementation files are unchanged.

Heavy local work ran sequentially on two CPUs with bounded Node/JVM heaps and a 4 GiB sampled process-family RSS stop line. The stopped DOM attempt and successful lower-cost control are both recorded.

Compatibility, safety, and release

No breaking changes or migration. Existing guide anchors and examples remain available. Windows, macOS GUI, ADB, IDA/JEB, enum limits, and the full native-provider matrix were not verified locally. Earlier real-provider receipts precede the rebases; final-head runs are identified separately above.

Uncertain Hopper lifecycle, cross-platform guarantees, active Electron reconciliation, ADB wording, and qualified scope questions remain unchanged and tracked in #2156. This PR does not close the umbrella issue or implement the README translation layout in #2141.

Review checklist

Agreed scope and Conventional Commit title.
Related issue linked; known proof gaps stated.
Existing regression coverage retained; relevant checks executed.
Authored docs/skill and generated metadata synchronized.
Final diff checked for unrelated files and unsupported claims.

_{🔄 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/2207 **Author:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Created:** 10/12/2026 **Status:** ✅ Merged **Merged:** 10/12/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/english-guides-refactor-2156` --- ### 📝 Commits (1) - [`bf6f06b`](https://github.com/morluto/rea/commit/bf6f06bef5aca676d562209a788bd73735109ce4) docs: correct drift and reorganize English guides ### 📊 Changes **25 files changed** (+2090 additions, -1849 deletions) <details> <summary>View changed files</summary> 📝 `.agents/skills/reverse-engineer-anything/SKILL.md` (+1 -1) 📝 `.agents/skills/reverse-engineer-anything/references/native-and-artifacts.md` (+9 -9) 📝 `docs/.vitepress/config.ts` (+6 -4) 📝 `docs/binary-diagnostics.md` (+3 -1) 📝 `docs/browser-observation.md` (+9 -1) 📝 `docs/cli.md` (+1 -1) ➕ `docs/client-configuration.md` (+225 -0) ➕ `docs/client-verification.md` (+488 -0) 📝 `docs/ghidra-dos.md` (+7 -4) 📝 `docs/index.md` (+20 -0) 📝 `docs/installation.md` (+243 -434) 📝 `docs/javascript-artifact-reconstruction.md` (+180 -159) 📝 `docs/managed-code-analysis.md` (+67 -61) 📝 `docs/mcp-contracts.md` (+358 -341) 📝 `docs/mcp-prompts.md` (+6 -0) 📝 `docs/native-investigation.md` (+179 -124) 📝 `docs/process-capture.md` (+91 -73) 📝 `docs/testing.md` (+185 -627) 📝 `docs/wasm-artifacts.md` (+1 -1) 📝 `docs/windows-ghidra-p0.md` (+4 -2) _...and 5 more files_ </details> ### 📄 Description ## Summary Refs #2156. Correct verified drift in the English guides and put usable workflows before implementation references. Root READMEs, translations, and `website/` are outside this PR. ## Problem and expected behavior Several guides describe older behavior: NativeAOT routing, cancellation retention, HAR keys, completion readiness, CDP limits, load-image verification, and large MCP replies. Installation and testing also mix first-use steps with long client-specific records. Readers need accurate instructions, explicit limits and recovery steps, and one owner for repeated rules. ## Change and scope - Correct the confirmed claims, broken catalog/WABT links, and Android fixture command. Preserve provider authority, provenance, partial-result recovery, and resource limits. - Reorder installation, testing, MCP, native, JavaScript, managed, and process guides around their tasks. Move client settings and verification records to two linked reference pages; consolidate Hopper analysis guidance in the native guide. - Preserve existing H2 anchors and fenced examples. Add runnable JS summary-to-view, managed inspection, and controlled process recipes. - Synchronize one Ghidra capability description with admitted raw imports. Increment the authored skill to version 40 and regenerate its tracked metadata. - Rebase onto `10400fdb`; retain the newly merged inventory/WASM view instructions, first-call WASM summaries, Frida guide/verification entries, and current six-shard CI rules. ## Contract and boundary impact - Semantic owner: authored documentation and skill references; the only runtime change is descriptive capability text. - CLI/MCP contracts: no operation, schema, request, or result-shape changes. - Providers/platforms: no authority or admission changes; Windows P0 remains without mutation authority. - Evidence/provenance: unchanged; documentation distinguishes retained complete records, partial coverage, derived views, and unknowns. - Execution/authorization/cleanup: unchanged. - Generated/package impact: skill version 40; ignored catalogs and packaged skills regenerated for verification, not committed. ## Evidence and regression coverage No tests are added or weakened. Existing focused checks cover doc/catalog consistency, prompt MCP, HAR, response budgets, raw/COM interpretation, Windows capability semantics, and newly merged inventory/WASM views. Real isolated Linux CLI/MCP probes verified Ghidra cold/warm completion and raw/COM attestation, NativeAOT symbols/type recovery, HAR own-key preservation and duplicate refusal, cancellation with partial retention/recovery, large ELF delivery with both endpoint budgets, native field truncation, and the new recipes. Real Chrome verified the 64 MiB CDP limit using a smaller escaped console payload after a large DOM probe hit our memory guard and was stopped. - [x] Observed, derived, and inferred claims remain distinguishable. - [x] Artifact identity, provenance, and failed attempts remain preserved. - [x] Unsupported, incomplete, unavailable, and uncertain outcomes remain visible. ## Validation performed Post-rebase validation against the final source tree: - `npm run docs:check -- --concurrency=2` — passed; refreshed runtime/skill/catalog artifacts. - `npm run test:focused` with 13 exact file paths — 77 tests passed, including the browser probe lifecycle regression. - `npm run check:fast -- --concurrency=2` — typecheck, lint, and module boundaries passed. - `npm run docs:build` — production pages and dead-link validation passed. - Exact-path `oxfmt --check --threads=2` and `git diff --check` — passed. - Seven guides' original H2 headings, 230 local links, and 23 JSON fences — passed. - Real documented CLI/MCP recipe probes and HAR/cancellation/recovery probes — passed again using the rebased runtime. The broader real Ghidra, NativeAOT, ELF-budget, native-field, and Chrome probes above passed before this rebase; their affected implementation files are unchanged. Heavy local work ran sequentially on two CPUs with bounded Node/JVM heaps and a 4 GiB sampled process-family RSS stop line. The stopped DOM attempt and successful lower-cost control are both recorded. ## Compatibility, safety, and release No breaking changes or migration. Existing guide anchors and examples remain available. Windows, macOS GUI, ADB, IDA/JEB, enum limits, and the full native-provider matrix were not verified locally. Earlier real-provider receipts precede the rebases; final-head runs are identified separately above. Uncertain Hopper lifecycle, cross-platform guarantees, active Electron reconciliation, ADB wording, and qualified scope questions remain unchanged and tracked in #2156. This PR does not close the umbrella issue or implement the README translation layout in #2141. ## Review checklist - [x] Agreed scope and Conventional Commit title. - [x] Related issue linked; known proof gaps stated. - [x] Existing regression coverage retained; relevant checks executed. - [x] Authored docs/skill and generated metadata synchronized. - [x] Final diff checked for unrelated files and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:03:34 +00:00

closed this issue
added the
pull-request
label

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#5084

No description provided.

Rows
Columns