morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 07:47:29 +00:00

[PR #1420] [MERGED] docs: correct stale logging, Ghidra host, and example path statements #2873

New issue

Closed

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

bsakaguchi commented

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

Owner

📋 Pull Request Information

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

Base: main ← Head: docs/correct-stale-statements

📝 Commits (2)

77f9b83 docs: correct stale logging, Ghidra host, and example path statements
07e58a1 docs: reconcile Ghidra requirements with current main

📊 Changes

3 files changed (+5 additions, -8 deletions)

View changed files

📝 CONTRIBUTING.md (+4 -3)
📝 docs/javascript-application-workflows.md (+1 -1)
📝 website/public/guides/browser/index.html (+0 -4)

📄 Description

Summary

This corrects four statements in the contributor docs, the user docs and the website that no longer match the code or the hosted site. Each one is a one-line or one-paragraph fix. They're grouped because they're all small factual corrections with no code changes. No issue is linked because these are small, self-contained corrections.

Problem and expected behavior

File	Stated	Actual
`CONTRIBUTING.md`	"one-shot CLI logging is opt-in on stdout"	`src/logger.ts` `createLogger` writes every mode to `pino.destination({ dest: 2 })`. Since `00c187e3`, CLI logs go to stderr so `--json` stdout stays parseable.
`website/public/get-started/index.html`	Ghidra needs a JDK "on Linux x64 or macOS x64/arm64"	`GhidraInstallation.ts` maps `linux: { x64, arm64 }`, and Linux arm64 shipped in 6.1.0. `docs/installation.md` and `docs/native-investigation.md` already say "Linux x64/arm64".
`website/public/guides/browser/index.html`	"The hosted example's request path includes the site's `/rea/` prefix."	The guide's start URL is `https://rea.tools/examples/notes-web/`. There, the request is `GET /examples/notes-web/notes.json`, which is exactly what the evidence table above the caption shows. The `/rea/` prefix applies only to the GitHub Pages mirror.
`docs/javascript-application-workflows.md`	"All five CLI commands accept inline JSON or a path to a JSON file"	The same page lists six tools. `inspect-analysis-view` (#1180) was added after this sentence was written, and all six `--help` texts say "Inline workflow JSON or JSON file path".

Change and scope

CONTRIBUTING.md: state that logs go to stderr in both modes.
Get started page: "Linux x64/arm64". Windows is left out because this provider card's commands are macOS/Linux shell.
Browser guide: remove the stale caption. The table already shows the real path.
JavaScript workflows doc: "five" becomes "six".

No other wording changes.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation and website copy only
CLI and MCP/tool-catalog contract: none
Provider, bridge, target-format, or platform compatibility: documentation now matches existing Ghidra host support; no behavior change
Evidence, artifact, provenance, or reconstruction contract: none
Process execution, authorization, cleanup, or containment impact: none
Generated metadata, package, or installation impact: none

Evidence and regression coverage

Tests added or updated: none; this PR changes documentation only.
Base reproduction / evidence:
- REA_LOG_LEVEL=info rea providers --json >out 2>err gives 0 log records on stdout and 1 ("mode":"cli") on stderr.
- curl -o /dev/null -w '%{http_code}' https://rea.tools/examples/notes-web/notes.json returns 200.
- curl -o /dev/null -w '%{http_code}' https://rea.tools/rea/examples/notes-web/notes.json returns 404.
- rea <command> --help for all six JavaScript workflow commands contains "JSON file path".
Remaining proof gaps: I did not deploy or preview the website on Cloudflare; I checked it locally only, as below.

Validation performed

All commands ran on macOS (arm64) with Node 24.18.0 and Python 3.12:

python3 scripts/prepare-website.py, then python3 scripts/verify-website.py: 17 HTML pages and 343 local references verified. Preparing changed no tracked files.
python3 scripts/test-website.py: 2 tests OK.
npm run check: passed, including format:check.
npm run docs:check: passed.
npm run docs:build: built successfully.

Compatibility, safety, and release

Breaking changes or migration steps: none
Real Hopper/Ghidra, browser, or OS coverage: not applicable
Package or release metadata impact: none
Security, privacy, process, or containment review: none

Review checklist

This PR addresses a concrete problem or an agreed enhancement.
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.
Owning docs, contracts, and generated metadata are updated where needed.
User-visible CLI/MCP changes include representative output.
I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🤖 Generated with Claude Code

_{🔄 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/1420 **Author:** [@Fazmin](https://github.com/Fazmin) **Created:** 10/10/2026 **Status:** ✅ Merged **Merged:** 10/10/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/correct-stale-statements` --- ### 📝 Commits (2) - [`77f9b83`](https://github.com/morluto/rea/commit/77f9b832fb4a0d23e3dbe8cfd22304b3cc95b273) docs: correct stale logging, Ghidra host, and example path statements - [`07e58a1`](https://github.com/morluto/rea/commit/07e58a190d6d24f8ec90e6f6c0363d2bd32ed01d) docs: reconcile Ghidra requirements with current main ### 📊 Changes **3 files changed** (+5 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `CONTRIBUTING.md` (+4 -3) 📝 `docs/javascript-application-workflows.md` (+1 -1) 📝 `website/public/guides/browser/index.html` (+0 -4) </details> ### 📄 Description ## Summary This corrects four statements in the contributor docs, the user docs and the website that no longer match the code or the hosted site. Each one is a one-line or one-paragraph fix. They're grouped because they're all small factual corrections with no code changes. No issue is linked because these are small, self-contained corrections. ## Problem and expected behavior | File | Stated | Actual | |---|---|---| | `CONTRIBUTING.md` | "one-shot CLI logging is opt-in on **stdout**" | `src/logger.ts` `createLogger` writes every mode to `pino.destination({ dest: 2 })`. Since 00c187e3, CLI logs go to stderr so `--json` stdout stays parseable. | | `website/public/get-started/index.html` | Ghidra needs a JDK "on Linux x64 or macOS x64/arm64" | `GhidraInstallation.ts` maps `linux: { x64, arm64 }`, and Linux arm64 shipped in 6.1.0. `docs/installation.md` and `docs/native-investigation.md` already say "Linux x64/arm64". | | `website/public/guides/browser/index.html` | "The hosted example's request path includes the site's `/rea/` prefix." | The guide's start URL is `https://rea.tools/examples/notes-web/`. There, the request is `GET /examples/notes-web/notes.json`, which is exactly what the evidence table above the caption shows. The `/rea/` prefix applies only to the GitHub Pages mirror. | | `docs/javascript-application-workflows.md` | "All **five** CLI commands accept inline JSON or a path to a JSON file" | The same page lists six tools. `inspect-analysis-view` (#1180) was added after this sentence was written, and all six `--help` texts say "Inline workflow JSON or JSON file path". | ## Change and scope - **`CONTRIBUTING.md`:** state that logs go to stderr in both modes. - **Get started page:** "Linux x64/arm64". Windows is left out because this provider card's commands are macOS/Linux shell. - **Browser guide:** remove the stale caption. The table already shows the real path. - **JavaScript workflows doc:** "five" becomes "six". No other wording changes. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation and website copy only - CLI and MCP/tool-catalog contract: none - Provider, bridge, target-format, or platform compatibility: documentation now matches existing Ghidra host support; no behavior change - Evidence, artifact, provenance, or reconstruction contract: none - Process execution, authorization, cleanup, or containment impact: none - Generated metadata, package, or installation impact: none ## Evidence and regression coverage - **Tests added or updated:** none; this PR changes documentation only. - **Base reproduction / evidence:** - `REA_LOG_LEVEL=info rea providers --json >out 2>err` gives 0 log records on stdout and 1 (`"mode":"cli"`) on stderr. - `curl -o /dev/null -w '%{http_code}' https://rea.tools/examples/notes-web/notes.json` returns `200`. - `curl -o /dev/null -w '%{http_code}' https://rea.tools/rea/examples/notes-web/notes.json` returns `404`. - `rea <command> --help` for all six JavaScript workflow commands contains "JSON file path". - **Remaining proof gaps:** I did not deploy or preview the website on Cloudflare; I checked it locally only, as below. ## Validation performed All commands ran on macOS (arm64) with Node 24.18.0 and Python 3.12: - `python3 scripts/prepare-website.py`, then `python3 scripts/verify-website.py`: 17 HTML pages and 343 local references verified. Preparing changed no tracked files. - `python3 scripts/test-website.py`: 2 tests OK. - `npm run check`: passed, including `format:check`. - `npm run docs:check`: passed. - `npm run docs:build`: built successfully. ## Compatibility, safety, and release - Breaking changes or migration steps: none - Real Hopper/Ghidra, browser, or OS coverage: not applicable - Package or release metadata impact: none - Security, privacy, process, or containment review: none ## Review checklist - [x] This PR addresses a concrete problem or an agreed enhancement. - [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. - [x] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

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

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-10-31 01:06:47 +00:00

[PR #2873] [MERGED] fix(source-maps): keep sources when sourcesContent length differs #5456

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

No description provided.

Rows
Columns