[PR #3484] [MERGED] docs(browser): reconcile HTTP discovery wording with browser sockets #5773

Closed
opened 2026-10-31 01:09:19 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/3484
Author: @0xRafie
Created: 10/14/2026
Status: ✅ Merged
Merged: 10/21/2026
Merged by: @morluto

Base: main ← Head: docs/browser-discovery-wording


📝 Commits (1)

  • 1f29b03 docs(browser): reconcile HTTP discovery wording with browser sockets

📊 Changes

1 file changed (+8 additions, -9 deletions)

View changed files

📝 docs/browser-observation.md (+8 -9)

📄 Description

Summary

After #2346, docs/browser-observation.md contradicts itself. "Start a browser" says "REA needs the browser's HTTP discovery endpoint", but the "Browsers without HTTP discovery" section lists six passive tools that accept a loopback browser socket. Both places also state the pipe/private-channel limitation. This PR rewords the first statement and links the section. It keeps one pipe statement and moves the workaround next to it.

Refs #2288: option 1 landed in #2287 and option 2 in #2346. This PR only aligns the docs; option 3 (pipe transport) is untouched.

Problem and expected behavior

A reader who stops at "Start a browser" may give up on a browser that exposes only a browser socket, although the route is documented about 20 lines later. Expected: one consistent statement.

Change and scope

  • The paragraph after the Chromium-family notes now says REA attaches through HTTP discovery or, for some passive tools, a browser socket, and links the section. The error-code sentence is unchanged.
  • That paragraph's pipe sentence is removed. The one at the end of "Browsers without HTTP discovery" gains the workaround: reproduce the page in a Chromium-family browser started with --remote-debugging-port.
  • Not included: the tool list, the Chrome toggle wording, any runtime change.

Contribution scope: documentation within existing boundaries; maintainer scope decision not applicable.

Contract and boundary impact

  • Semantic owner and earliest changed stage: docs/browser-observation.md.

  • Contribution scope fit and linked maintainer decision: documentation-only; not applicable.

  • CLI and MCP/tool-catalog contract: none.

  • Provider, bridge, target-format, or platform compatibility: none.

  • Evidence, artifact, provenance, or reconstruction contract: none.

  • Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable.

  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: none; no generated files changed.

  • Read existing files or captured data.

  • Launch or attach to a process.

  • Inject instrumentation or run scripts/code.

  • Change process memory, registers, files, or configuration.

  • Contact network services.

  • Recover protected code or work around protections.

  • Documentation or usability only; no target interaction.

  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none (documentation only).
  • Base reproduction or other evidence (source and link checks):
    • On cbc0e97, line 101 says "REA needs the browser's HTTP discovery endpoint", while lines 140-143 list the tools that accept a browser socket.
    • The new link reuses the anchor that "Request boundary" already links (#browsers-without-http-discovery).
    • endpoint_unreachable is raised for both HTTP discovery (src/browser/CdpEndpoint.ts) and WebSocket open failures (src/browser/CdpConnection.ts). The unchanged error-code sentence therefore still holds after the socket mention.
  • User-visible CLI/MCP output (if applicable): not applicable.
  • Remaining proof gaps: no browser run, because no behavior changed.

Validation performed

All on commit 1f29b03 (main cbc0e97 plus this change):

  • npm run check — passed (6/6 tasks; format:check ran on this commit, the other tasks were turbo cache hits; architecture guards passed across 1394 source files).
  • npm run docs:check — passed (1 file, 5 tests).
  • npm run verify:package — passed (207 MCP tools).
  • npm pack --dry-run — passed (1648 files); docs/ is not in the tarball.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable (wording only).
  • Package or release metadata impact: none; docs/ is not in the npm package.
  • Security, privacy, process, or containment review: none.

Author readiness

Human owner: @0xRafie

  • 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.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths. (Documentation only; no behavior change.)
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output. (Not applicable.)
  • I checked the final diff for secrets, unrelated cleanup, 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/3484 **Author:** [@0xRafie](https://github.com/0xRafie) **Created:** 10/14/2026 **Status:** ✅ Merged **Merged:** 10/21/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/browser-discovery-wording` --- ### 📝 Commits (1) - [`1f29b03`](https://github.com/morluto/rea/commit/1f29b033dbf0bca0852445c268a3f93248f187f6) docs(browser): reconcile HTTP discovery wording with browser sockets ### 📊 Changes **1 file changed** (+8 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `docs/browser-observation.md` (+8 -9) </details> ### 📄 Description ## Summary After #2346, `docs/browser-observation.md` contradicts itself. "Start a browser" says "REA needs the browser's HTTP discovery endpoint", but the "Browsers without HTTP discovery" section lists six passive tools that accept a loopback browser socket. Both places also state the pipe/private-channel limitation. This PR rewords the first statement and links the section. It keeps one pipe statement and moves the workaround next to it. Refs #2288: option 1 landed in #2287 and option 2 in #2346. This PR only aligns the docs; option 3 (pipe transport) is untouched. ## Problem and expected behavior A reader who stops at "Start a browser" may give up on a browser that exposes only a browser socket, although the route is documented about 20 lines later. Expected: one consistent statement. ## Change and scope - The paragraph after the Chromium-family notes now says REA attaches through HTTP discovery or, for some passive tools, a browser socket, and links the section. The error-code sentence is unchanged. - That paragraph's pipe sentence is removed. The one at the end of "Browsers without HTTP discovery" gains the workaround: reproduce the page in a Chromium-family browser started with `--remote-debugging-port`. - Not included: the tool list, the Chrome toggle wording, any runtime change. Contribution scope: documentation within existing boundaries; maintainer scope decision not applicable. ## Contract and boundary impact - Semantic owner and earliest changed stage: `docs/browser-observation.md`. - Contribution scope fit and linked maintainer decision: documentation-only; not applicable. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none; no generated files changed. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none (documentation only). - Base reproduction or other evidence (source and link checks): - On `cbc0e97`, line 101 says "REA needs the browser's HTTP discovery endpoint", while lines 140-143 list the tools that accept a browser socket. - The new link reuses the anchor that "Request boundary" already links (`#browsers-without-http-discovery`). - `endpoint_unreachable` is raised for both HTTP discovery (`src/browser/CdpEndpoint.ts`) and WebSocket open failures (`src/browser/CdpConnection.ts`). The unchanged error-code sentence therefore still holds after the socket mention. - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: no browser run, because no behavior changed. ## Validation performed All on commit `1f29b03` (main `cbc0e97` plus this change): - `npm run check` — passed (6/6 tasks; `format:check` ran on this commit, the other tasks were turbo cache hits; architecture guards passed across 1394 source files). - `npm run docs:check` — passed (1 file, 5 tests). - `npm run verify:package` — passed (207 MCP tools). - `npm pack --dry-run` — passed (1648 files); `docs/` is not in the tarball. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable (wording only). - Package or release metadata impact: none; `docs/` is not in the npm package. - Security, privacy, process, or containment review: none. ## Author readiness Human owner: @0xRafie - [x] 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. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. (Documentation only; no behavior change.) - [x] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. (Not applicable.) - [x] I checked the final diff for secrets, unrelated cleanup, 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:09:19 +00:00
Sign in to join this conversation.
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#5773
No description provided.