[PR #5028] [CLOSED] docs: link out-of-tree experiment notes by GitHub URL #6744

Closed
opened 2026-11-01 21:42:44 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/5028
Author: @baccouche-sami
Created: 10/18/2026
Status: ❌ Closed

Base: main ← Head: docs/fix-out-of-tree-experiment-links


📝 Commits (2)

📄 Description

Summary

npm run docs:build (VitePress) fails on main at 23f984b1a with six dead
links to files under experiments/analysis-efficiency/. VitePress cannot
resolve relative links that leave docs/. Draft #4769 repairs three of them
(in docs/verification/). This PR repairs the other three, introduced by
#5002 and 7c458f04b, so the two PRs together make the documentation build
pass again.

No issue is linked: none exists for these three links, and #4769 does not
cover them.

Problem and expected behavior

Smallest trigger: npx vitepress build docs on main reports
6 dead link(s) found and exits 1. Three come from:

  • docs/apktool-resource-analysis.md →
    ../experiments/analysis-efficiency/apktool-string-tables.md
  • docs/jeb-analysis.md → ../experiments/analysis-efficiency/jeb-linux-native.md
  • docs/testing.md → ../experiments/analysis-efficiency/jeb-linux-native.md

CONTRIBUTING.md asks to link repository files outside docs/ using their full
GitHub URLs, so the links work on both GitHub and the website.

Change and scope

The three links now use
https://github.com/morluto/rea/blob/main/experiments/analysis-efficiency/...,
the same form already used in docs/testing.md and docs/ida-provider.md for
ida-native-windows.md. Link text is unchanged.

Not included: the three dead links handled by #4769, and any CI change.
npm run docs:check passes on main while docs:build fails, because only the
manual pages.yml workflow builds the site. A follow-up could add
npm run docs:build to the CI docs job after both PRs land; I will raise that
separately rather than widen this PR.

Contribution scope: documentation-only fix within existing boundaries; no
maintainer scope decision required.

Contract and boundary impact

  • Semantic owner and earliest changed stage: authored documentation (docs/).
  • Contribution scope fit and linked maintainer decision: not applicable (documentation link fix).
  • 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.

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 (documentation links only).
  • Base reproduction or other evidence (executed, macOS arm64, Node 24.18.0):
    • main 23f984b1a: npx vitepress build docs → 6 dead links, build failed.
    • This branch: 3 dead links remain, all in files changed by #4769.
    • This branch + #4769 head merged with main 23f984b1a: build complete,
      no dead links. The generated HTML for the three pages contains the GitHub
      URLs, and both target files exist on main.
  • User-visible CLI/MCP output (if applicable): not applicable.
  • Remaining proof gaps: Linux CI pages.yml was not run; the combined result
    depends on #4769 landing as currently written.

Validation performed

  • npx vitepress build docs on main — failed, 6 dead links.
  • npx vitepress build docs on this branch — failed, 3 dead links (the #4769 set).
  • npx vitepress build docs on this branch + #4769 — build complete in 4.58s.
  • npm run docs:check — passed.
  • npm run check:fast (pre-push hook) — passed.

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: not applicable; links point to existing public repository files.

Author readiness

Human owner: @baccouche-sami

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

🤖 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/5028 **Author:** [@baccouche-sami](https://github.com/baccouche-sami) **Created:** 10/18/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/fix-out-of-tree-experiment-links` --- ### 📝 Commits (2) - [`696b0b9`](https://github.com/morluto/rea/commit/696b0b9f6082bbb3b409ff7bcc5aa4c8dbf6d81b) docs: link out-of-tree experiment notes by GitHub URL - [`233e06a`](https://github.com/morluto/rea/commit/233e06adfddbc00c7eb2ba1bc23ec9f1e45fd046) Merge branch 'main' of https://github.com/morluto/rea into docs/fix-out-of-tree-experiment-links ### 📄 Description <!-- PR title: type(optional-scope): imperative outcome The title becomes the squash-merge commit subject and generated changelog entry. --> ## Summary `npm run docs:build` (VitePress) fails on `main` at 23f984b1a with six dead links to files under `experiments/analysis-efficiency/`. VitePress cannot resolve relative links that leave `docs/`. Draft #4769 repairs three of them (in `docs/verification/`). This PR repairs the other three, introduced by #5002 and 7c458f04b, so the two PRs together make the documentation build pass again. No issue is linked: none exists for these three links, and #4769 does not cover them. ## Problem and expected behavior Smallest trigger: `npx vitepress build docs` on `main` reports `6 dead link(s) found` and exits 1. Three come from: - `docs/apktool-resource-analysis.md` → `../experiments/analysis-efficiency/apktool-string-tables.md` - `docs/jeb-analysis.md` → `../experiments/analysis-efficiency/jeb-linux-native.md` - `docs/testing.md` → `../experiments/analysis-efficiency/jeb-linux-native.md` CONTRIBUTING.md asks to link repository files outside `docs/` using their full GitHub URLs, so the links work on both GitHub and the website. ## Change and scope The three links now use `https://github.com/morluto/rea/blob/main/experiments/analysis-efficiency/...`, the same form already used in `docs/testing.md` and `docs/ida-provider.md` for `ida-native-windows.md`. Link text is unchanged. Not included: the three dead links handled by #4769, and any CI change. `npm run docs:check` passes on `main` while `docs:build` fails, because only the manual `pages.yml` workflow builds the site. A follow-up could add `npm run docs:build` to the CI `docs` job after both PRs land; I will raise that separately rather than widen this PR. Contribution scope: documentation-only fix within existing boundaries; no maintainer scope decision required. ## Contract and boundary impact - Semantic owner and earliest changed stage: authored documentation (`docs/`). - Contribution scope fit and linked maintainer decision: not applicable (documentation link fix). - 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. 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 (documentation links only). - Base reproduction or other evidence (executed, macOS arm64, Node 24.18.0): - `main` 23f984b1a: `npx vitepress build docs` → 6 dead links, build failed. - This branch: 3 dead links remain, all in files changed by #4769. - This branch + #4769 head merged with `main` 23f984b1a: build complete, no dead links. The generated HTML for the three pages contains the GitHub URLs, and both target files exist on `main`. - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: Linux CI `pages.yml` was not run; the combined result depends on #4769 landing as currently written. ## Validation performed - `npx vitepress build docs` on `main` — failed, 6 dead links. - `npx vitepress build docs` on this branch — failed, 3 dead links (the #4769 set). - `npx vitepress build docs` on this branch + #4769 — build complete in 4.58s. - `npm run docs:check` — passed. - `npm run check:fast` (pre-push hook) — passed. ## 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: not applicable; links point to existing public repository files. ## Author readiness <!-- The human owner completes these declarations before requesting review. The PR author is the owner by default. A different owner must explicitly accept ownership on this PR. AI agents must leave these declarations to a human to dictate to them or there could be catastrophic consequences for many users of REA. Draft PRs may leave them unchecked. These declarations record initial readiness when opening the PR for review; later pushes do not require a new human sign-off. Keep the description and validation evidence current as the work changes. See CONTRIBUTING.md#pull-request-ownership-and-readiness. --> Human owner: @baccouche-sami - [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 <!-- Draft PRs may leave pending items unchecked. Resolve material scope and authority questions before integration. --> - [ ] 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. 🤖 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-11-01 21:42:44 +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#6744
No description provided.