[PR #237] [MERGED] docs: reconcile product documentation with shipped behavior #1888

New issue

Closed

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

bsakaguchi commented

2026-10-16 21:12:12 +00:00

Owner

📋 Pull Request Information

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

Base: main ← Head: agent/repair-product-documentation-drift

📝 Commits (1)

54056a9 docs: reconcile product documentation with shipped behavior

📊 Changes

939 files changed (+23029 additions, -3374 deletions)

View changed files

📝 .github/pull_request_template.md (+2 -1)
📝 AGENTS.md (+3 -3)
📝 README.md (+33 -24)
📝 README_ar.md (+3 -3)
📝 README_ja.md (+3 -3)
📝 README_ko.md (+3 -3)
📝 README_zh.md (+3 -3)
📝 docs/api/assets/hierarchy.js (+1 -1)
📝 docs/api/assets/navigation.js (+1 -1)
📝 docs/api/assets/search.js (+1 -1)
➕ docs/api/classes/application_AnalysisSnapshotCache.AnalysisSnapshotCache.html (+212 -0)
📝 docs/api/classes/application_BinarySession.BinarySession.html (+153 -58)
📝 docs/api/classes/application_CompositeProvider.CompositeProvider.html (+3 -3)
📝 docs/api/classes/application_EnhancedTools.EnhancedTools.html (+4 -4)
📝 docs/api/classes/application_EvidenceLedger.EvidenceLedger.html (+26 -26)
➕ docs/api/classes/application_PermissionAuthority.PermissionAuthority.html (+217 -0)
📝 docs/api/classes/application_PermissionAuthority.PermissionPathError.html (+38 -37)
➕ docs/api/classes/application_ProcessCaptureError.ProcessCaptureError.html (+122 -0)
📝 docs/api/classes/application_ProcessCheckpoints.ProcessCheckpoints.html (+3 -3)
➕ docs/api/classes/application_ProjectPermissionStore.ProjectPermissionStoreError.html (+93 -0)

...and 80 more files

📄 Description

Summary

reconcile the documented MCP inventory with the shipped 78-tool surface: 33 direct, 10 enhanced, 5 native, 2 artifact, 8 browser, 2 Electron, and 18 session tools
document the full setup detection matrix and its actual write behavior: six supported clients are configured while Devin is detection-only
replace stale macOS-only, Linux licensing, installation, roadmap, and provider-evaluation claims with the current product behavior and an explicit Now/Next/Later sequence
accept Ghidra as the next read-only deep-analysis provider direction without claiming that Ghidra support already ships
regenerate the committed TypeDoc site from the 1.6.0 source tree, including the Process Capture v4 contract, and refresh generated package metadata
add localized README consistency coverage for all seven detected setup clients

Why

The implementation had advanced substantially beyond the checked-in documentation. The public docs still described older tool counts, only two automatically configured clients, a macOS-only local host, an activated-license requirement on Linux, TypeDoc from 1.1.0, and Process Capture v3. Those mismatches made it difficult to distinguish shipped behavior from future direction.

This PR restores a truthful baseline before provider and browser/Electron expansion begins. It intentionally changes documentation, generated API pages, tests, and non-behavioral comments only; it does not add Ghidra routing or alter runtime contracts.

Contract and behavior impact

MCP tool contracts: no change
CLI/MCP runtime behavior: no change
setup behavior: no change; documentation now matches the shipped implementation
provider support: no change; Hopper remains the shipped deep-analysis provider and Ghidra is recorded only as the accepted next direction

Verification

npx vitest run --coverage.enabled=false tests/readmeConsistency.test.ts tests/serverIdentity.test.ts — 2 files, 10 tests passed
npm run docs:generate — generated successfully with 0 errors; the 90 warnings identify internal referenced types that TypeDoc does not publish
generated docs/api/ twice and compared a whole-tree SHA-256 — identical output (cbf43268148c0893c4edfa64d7e24775487d74909608805b317ffb7be6465537)
npm run check — passed
npm test -- --reporter=dot — 105 files, 720 tests passed
npm run verify:package — passed with the packaged 78-tool target-free MCP server

Real provider verification

Real Hopper verification was not run because this PR does not change Hopper behavior or make a new Hopper claim.
Real browser verification was not run because this PR does not change browser/Electron behavior or make a new runtime claim.

_{🔄 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/237 **Author:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Created:** 7/15/2026 **Status:** ✅ Merged **Merged:** 7/15/2026 **Merged by:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Base:** `main` ← **Head:** `agent/repair-product-documentation-drift` --- ### 📝 Commits (1) - [`54056a9`](https://github.com/morluto/rea/commit/54056a9782f3f51f8f1b510d8b9c1bf4c3c9f067) docs: reconcile product documentation with shipped behavior ### 📊 Changes **939 files changed** (+23029 additions, -3374 deletions) <details> <summary>View changed files</summary> 📝 `.github/pull_request_template.md` (+2 -1) 📝 `AGENTS.md` (+3 -3) 📝 `README.md` (+33 -24) 📝 `README_ar.md` (+3 -3) 📝 `README_ja.md` (+3 -3) 📝 `README_ko.md` (+3 -3) 📝 `README_zh.md` (+3 -3) 📝 `docs/api/assets/hierarchy.js` (+1 -1) 📝 `docs/api/assets/navigation.js` (+1 -1) 📝 `docs/api/assets/search.js` (+1 -1) ➕ `docs/api/classes/application_AnalysisSnapshotCache.AnalysisSnapshotCache.html` (+212 -0) 📝 `docs/api/classes/application_BinarySession.BinarySession.html` (+153 -58) 📝 `docs/api/classes/application_CompositeProvider.CompositeProvider.html` (+3 -3) 📝 `docs/api/classes/application_EnhancedTools.EnhancedTools.html` (+4 -4) 📝 `docs/api/classes/application_EvidenceLedger.EvidenceLedger.html` (+26 -26) ➕ `docs/api/classes/application_PermissionAuthority.PermissionAuthority.html` (+217 -0) 📝 `docs/api/classes/application_PermissionAuthority.PermissionPathError.html` (+38 -37) ➕ `docs/api/classes/application_ProcessCaptureError.ProcessCaptureError.html` (+122 -0) 📝 `docs/api/classes/application_ProcessCheckpoints.ProcessCheckpoints.html` (+3 -3) ➕ `docs/api/classes/application_ProjectPermissionStore.ProjectPermissionStoreError.html` (+93 -0) _...and 80 more files_ </details> ### 📄 Description ## Summary - reconcile the documented MCP inventory with the shipped 78-tool surface: 33 direct, 10 enhanced, 5 native, 2 artifact, 8 browser, 2 Electron, and 18 session tools - document the full setup detection matrix and its actual write behavior: six supported clients are configured while Devin is detection-only - replace stale macOS-only, Linux licensing, installation, roadmap, and provider-evaluation claims with the current product behavior and an explicit Now/Next/Later sequence - accept Ghidra as the next read-only deep-analysis provider direction without claiming that Ghidra support already ships - regenerate the committed TypeDoc site from the 1.6.0 source tree, including the Process Capture v4 contract, and refresh generated package metadata - add localized README consistency coverage for all seven detected setup clients ## Why The implementation had advanced substantially beyond the checked-in documentation. The public docs still described older tool counts, only two automatically configured clients, a macOS-only local host, an activated-license requirement on Linux, TypeDoc from 1.1.0, and Process Capture v3. Those mismatches made it difficult to distinguish shipped behavior from future direction. This PR restores a truthful baseline before provider and browser/Electron expansion begins. It intentionally changes documentation, generated API pages, tests, and non-behavioral comments only; it does not add Ghidra routing or alter runtime contracts. ## Contract and behavior impact - MCP tool contracts: no change - CLI/MCP runtime behavior: no change - setup behavior: no change; documentation now matches the shipped implementation - provider support: no change; Hopper remains the shipped deep-analysis provider and Ghidra is recorded only as the accepted next direction ## Verification - `npx vitest run --coverage.enabled=false tests/readmeConsistency.test.ts tests/serverIdentity.test.ts` — 2 files, 10 tests passed - `npm run docs:generate` — generated successfully with 0 errors; the 90 warnings identify internal referenced types that TypeDoc does not publish - generated `docs/api/` twice and compared a whole-tree SHA-256 — identical output (`cbf43268148c0893c4edfa64d7e24775487d74909608805b317ffb7be6465537`) - `npm run check` — passed - `npm test -- --reporter=dot` — 105 files, 720 tests passed - `npm run verify:package` — passed with the packaged 78-tool target-free MCP server ## Real provider verification - Real Hopper verification was not run because this PR does not change Hopper behavior or make a new Hopper claim. - Real browser verification was not run because this PR does not change browser/Electron behavior or make a new runtime claim. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-16 21:12:12 +00:00