[PR #7257] [CLOSED] docs(install): document the reviewable tagged installer path #7752

Closed
opened 2026-11-03 13:40:08 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/7257
Author: @BeqaKs
Created: 10/26/2026
Status: ❌ Closed

Base: main ← Head: docs/reviewable-install-sh


📝 Commits (1)

  • bb37b48 docs(install): document the reviewable tagged installer path

📊 Changes

2 files changed (+22 additions, -5 deletions)

View changed files

📝 docs/installation.md (+13 -5)
📝 website/public/get-started/index.html (+9 -0)

📄 Description

Summary

Fixes #3439 by making the reviewable tagged install.sh path explicit next to the existing main curl|bash example, and linking the get-started page to that section.

Problem and expected behavior

docs/installation.md (and the get-started curl example) presented curl …/main/install.sh | bash, which runs unsigned main at fetch time. Operators who want a reviewable install needed a documented path: download install.sh from rea-agents-<version>, read it, then run with --version <version>.

Change and scope

  • Clarify installer carefulness (HTTPS release metadata, no sudo, plan-before-write, version check) and that the main pipe path is unsigned/main-at-fetch-time.
  • Keep the tagged download → review → bash … --version flow; bump the example pin to 6.8.0.
  • One-line get-started cross-link to the installation docs (no broader website pinning rewrite; that remains #3423).

Follow the contribution scope.
Unresolved scope, authority, side effects, or required verification block
integration. Link the required maintainer scope decision for new providers or
capabilities involving target execution, injection, mutation, or protection
recovery; ordinary fixes within existing boundaries may state "not applicable".
Draft PRs may leave the scope decision pending and the readiness and merge checklists
unchecked. Maintainers can help resolve open questions.

Contract and boundary impact

  • Semantic owner and earliest changed stage: authored installation docs and get-started copy only.
  • Contribution scope fit and linked maintainer decision: not applicable (documentation-only).
  • 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): none.
  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: none (docs/website copy only).

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

  • 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 (docs-only).
  • Base reproduction or other evidence: source review of docs/installation.md and website/public/get-started/index.html against #3439.
  • User-visible CLI/MCP output (if applicable): none.
  • Remaining proof gaps: website translations beyond English get-started were not updated; #3423 package-runner @latest pinning is out of scope.

For boundary fixes, identify the applicable boundary regressions
and lifecycle regressions
covered by the evidence above, and explain relevant gaps.

For evidence-bearing changes:

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

Validation performed

  • npm run docs:check — passed (docs:check:built tasks successful; tests/conformance/readmeConsistency.test.ts 9/9 passed).
  • Manual docs review of the Global installation wrapper section and get-started curl blurb.

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: documents existing unsigned-main risk and reviewable tagged alternative; does not claim script signature verification.

Author readiness

Human owner: @BeqaKs

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

🔄 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/7257 **Author:** [@BeqaKs](https://github.com/BeqaKs) **Created:** 10/26/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/reviewable-install-sh` --- ### 📝 Commits (1) - [`bb37b48`](https://github.com/morluto/rea/commit/bb37b48b9aaa796187101e3f38ffdc0a542c030d) docs(install): document the reviewable tagged installer path ### 📊 Changes **2 files changed** (+22 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `docs/installation.md` (+13 -5) 📝 `website/public/get-started/index.html` (+9 -0) </details> ### 📄 Description ## Summary Fixes #3439 by making the reviewable tagged `install.sh` path explicit next to the existing `main` curl|bash example, and linking the get-started page to that section. ## Problem and expected behavior `docs/installation.md` (and the get-started curl example) presented `curl …/main/install.sh | bash`, which runs unsigned `main` at fetch time. Operators who want a reviewable install needed a documented path: download `install.sh` from `rea-agents-<version>`, read it, then run with `--version <version>`. ## Change and scope - Clarify installer carefulness (HTTPS release metadata, no `sudo`, plan-before-write, version check) and that the `main` pipe path is unsigned/main-at-fetch-time. - Keep the tagged download → review → `bash … --version` flow; bump the example pin to `6.8.0`. - One-line get-started cross-link to the installation docs (no broader website pinning rewrite; that remains #3423). Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Unresolved scope, authority, side effects, or required verification block integration. Link the required maintainer scope decision for new providers or capabilities involving target execution, injection, mutation, or protection recovery; ordinary fixes within existing boundaries may state "not applicable". Draft PRs may leave the scope decision pending and the readiness and merge checklists unchecked. Maintainers can help resolve open questions. ## Contract and boundary impact - Semantic owner and earliest changed stage: authored installation docs and get-started copy only. - Contribution scope fit and linked maintainer decision: not applicable (documentation-only). - 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): none. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none (docs/website copy only). Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] 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 (docs-only). - Base reproduction or other evidence: source review of `docs/installation.md` and `website/public/get-started/index.html` against #3439. - User-visible CLI/MCP output (if applicable): none. - Remaining proof gaps: website translations beyond English get-started were not updated; #3423 package-runner `@latest` pinning is out of scope. For boundary fixes, identify the applicable [boundary regressions](https://github.com/morluto/rea/blob/main/docs/testing.md#boundary-regressions) and [lifecycle regressions](https://github.com/morluto/rea/blob/main/docs/testing.md#lifecycle-regressions) covered by the evidence above, and explain relevant gaps. For evidence-bearing changes: - [ ] Observed, derived, and inferred claims remain distinguishable. - [ ] Artifact identity, source provenance, and failed attempts remain preserved. - [ ] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed - `npm run docs:check` — passed (docs:check:built tasks successful; `tests/conformance/readmeConsistency.test.ts` 9/9 passed). - Manual docs review of the Global installation wrapper section and get-started curl blurb. ## 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: documents existing unsigned-main risk and reviewable tagged alternative; does not claim script signature verification. ## Author readiness Human owner: @BeqaKs - [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 - [ ] 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. - [ ] 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-11-03 13:40:08 +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#7752
No description provided.