morluto/rea

Fork 0

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

[PR #4769] [CLOSED] docs: repair out-of-tree links so the documentation build passes #6401

New issue

Closed

opened 2026-10-31 01:14:12 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:14:12 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4769
Author: @sathish123m
Created: 10/17/2026
Status: ❌ Closed

Base: main ← Head: docs/verification-repo-links

📝 Commits (1)

68e22f1 docs: repair out-of-tree links so the documentation build passes

📊 Changes

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

View changed files

📝 docs/ghidra-nativeaot.md (+1 -1)
📝 docs/verification/electron-cancellation-2026-10-16.md (+1 -1)
📝 docs/verification/javascript-analysis-effects-2026-10-15.md (+1 -1)
📝 docs/verification/javascript-retained-facts-2026-10-15.md (+2 -2)
📝 docs/verification/javascript-window-options-2026-10-16.md (+3 -3)

📄 Description

Summary

Seven relative links in four verification records and one in
docs/ghidra-nativeaot.md pointed outside the docs tree
(../../experiments/..., ../../src/..., ../licenses/...). VitePress
resolves those against the site, so three fail npm run docs:build as dead
links and the rest would 404 on the deployed documentation. All now use the
pinned repository URL form that sibling records already use.

Problem and expected behavior

Smallest trigger: npm run docs:build on this base (9c56d09c0) fails:

(!) Found dead link ./../../experiments/analysis-efficiency/resource-counters in file verification/electron-cancellation-2026-10-16.md
(!) Found dead link ./../../experiments/analysis-efficiency/javascript-facts-grade.py in file verification/javascript-retained-facts-2026-10-15.md
(!) Found dead link ./../../experiments/analysis-efficiency/joplin-window-options-check.py in file verification/javascript-window-options-2026-10-16.md
[vitepress] 3 dead link(s) found.

Expected behavior: the build completes with no dead links, and every link in
these records resolves from both GitHub and the deployed documentation. The
relative form is also used for licenses/nativeaot-parser-MIT.txt in
docs/ghidra-nativeaot.md, which 404s on the deployed site although the
checker does not flag it.

Change and scope

docs/verification/electron-cancellation-2026-10-16.md,
docs/verification/javascript-analysis-effects-2026-10-15.md,
docs/verification/javascript-retained-facts-2026-10-15.md and
docs/verification/javascript-window-options-2026-10-16.md: harness and
source links now use
https://github.com/morluto/rea/blob/b3bdabab694af1f9801eff7caf75001b92314a58/...,
the pin these records already use for resource-run.py (e.g.
javascript-retained-facts-2026-10-15.md:86). Every target exists at that
pin (checked through the repository contents API).
docs/ghidra-nativeaot.md: the same class of link to
licenses/nativeaot-parser-MIT.txt now uses the blob/main URL.
Intentionally not included: docs/readme/* links, because the site excludes
readme/** through srcExclude and their relative form is correct for
browsing the repository; and /rea/product-catalog.json in
docs/mcp-contracts.md, which is an intentional deployment path.

Contribution scope: documentation-only; no target execution, injection,
mutation or protection recovery. Maintainer scope decision: not applicable.

Contract and boundary impact

Semantic owner and earliest changed stage: not applicable (documentation).
Contribution scope fit and linked maintainer decision: docs-only; not applicable.
CLI and MCP/tool-catalog contract: none.
Provider, bridge, target-format, or platform compatibility: none.
Evidence, artifact, provenance, or reconstruction contract: link text and targets are unchanged; only the URL form changed, and the pin preserves the versions the records already reference.
Target selection, authority, upstream behavior, and cleanup details: none.
Generated metadata (docs/public/product-catalog.json), package, or installation impact: none.

Expected effects (documentation-only on its own):

Documentation or usability only; no target interaction.

Evidence and regression coverage

Tests added or updated: none; the existing docs gates cover the change and
the build failure itself is the regression.
Base reproduction or other evidence: the npm run docs:build output above
(exit 1, three dead links) on this base; after the change the same command
completes with 0 dead links and exit 0.
All seven link targets exist at the pinned revision (verified with the
contents API, ?ref=b3bdabab694af1f9801eff7caf75001b92314a58).
Remaining proof gaps: none for this change.

Validation performed

npm run docs:build — exit 0, build complete, no dead links (base: exit 1, 3 dead links).
npm run docs:check — passed (readmeConsistency 5 tests passed).
npx oxfmt --check on every edited file — clean.
git grep "](\.\./\.\./" docs/verification — no matches remain.
git diff --stat — 8 insertions, 8 deletions across 5 files.

Compatibility, safety, and release

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

Author readiness

Human owner: @sathish123m

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/4769 **Author:** [@sathish123m](https://github.com/sathish123m) **Created:** 10/17/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/verification-repo-links` --- ### 📝 Commits (1) - [`68e22f1`](https://github.com/morluto/rea/commit/68e22f161c411036488b1da12fdb470d93b1c25e) docs: repair out-of-tree links so the documentation build passes ### 📊 Changes **5 files changed** (+8 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `docs/ghidra-nativeaot.md` (+1 -1) 📝 `docs/verification/electron-cancellation-2026-10-16.md` (+1 -1) 📝 `docs/verification/javascript-analysis-effects-2026-10-15.md` (+1 -1) 📝 `docs/verification/javascript-retained-facts-2026-10-15.md` (+2 -2) 📝 `docs/verification/javascript-window-options-2026-10-16.md` (+3 -3) </details> ### 📄 Description ## Summary Seven relative links in four verification records and one in `docs/ghidra-nativeaot.md` pointed outside the docs tree (`../../experiments/...`, `../../src/...`, `../licenses/...`). VitePress resolves those against the site, so three fail `npm run docs:build` as dead links and the rest would 404 on the deployed documentation. All now use the pinned repository URL form that sibling records already use. ## Problem and expected behavior Smallest trigger: `npm run docs:build` on this base (`9c56d09c0`) fails: ``` (!) Found dead link ./../../experiments/analysis-efficiency/resource-counters in file verification/electron-cancellation-2026-10-16.md (!) Found dead link ./../../experiments/analysis-efficiency/javascript-facts-grade.py in file verification/javascript-retained-facts-2026-10-15.md (!) Found dead link ./../../experiments/analysis-efficiency/joplin-window-options-check.py in file verification/javascript-window-options-2026-10-16.md [vitepress] 3 dead link(s) found. ``` Expected behavior: the build completes with no dead links, and every link in these records resolves from both GitHub and the deployed documentation. The relative form is also used for `licenses/nativeaot-parser-MIT.txt` in `docs/ghidra-nativeaot.md`, which 404s on the deployed site although the checker does not flag it. ## Change and scope - `docs/verification/electron-cancellation-2026-10-16.md`, `docs/verification/javascript-analysis-effects-2026-10-15.md`, `docs/verification/javascript-retained-facts-2026-10-15.md` and `docs/verification/javascript-window-options-2026-10-16.md`: harness and source links now use `https://github.com/morluto/rea/blob/b3bdabab694af1f9801eff7caf75001b92314a58/...`, the pin these records already use for `resource-run.py` (e.g. `javascript-retained-facts-2026-10-15.md:86`). Every target exists at that pin (checked through the repository contents API). - `docs/ghidra-nativeaot.md`: the same class of link to `licenses/nativeaot-parser-MIT.txt` now uses the `blob/main` URL. - Intentionally not included: `docs/readme/*` links, because the site excludes `readme/**` through `srcExclude` and their relative form is correct for browsing the repository; and `/rea/product-catalog.json` in `docs/mcp-contracts.md`, which is an intentional deployment path. Contribution scope: documentation-only; no target execution, injection, mutation or protection recovery. Maintainer scope decision: not applicable. ## Contract and boundary impact - Semantic owner and earliest changed stage: not applicable (documentation). - Contribution scope fit and linked maintainer decision: docs-only; not applicable. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: link text and targets are unchanged; only the URL form changed, and the pin preserves the versions the records already reference. - Target selection, authority, upstream behavior, and cleanup details: none. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none. Expected effects (documentation-only on its own): - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Tests added or updated: none; the existing docs gates cover the change and the build failure itself is the regression. - Base reproduction or other evidence: the `npm run docs:build` output above (exit 1, three dead links) on this base; after the change the same command completes with `0` dead links and exit 0. - All seven link targets exist at the pinned revision (verified with the contents API, `?ref=b3bdabab694af1f9801eff7caf75001b92314a58`). - Remaining proof gaps: none for this change. ## Validation performed - `npm run docs:build` — exit 0, build complete, no dead links (base: exit 1, 3 dead links). - `npm run docs:check` — passed (`readmeConsistency` 5 tests passed). - `npx oxfmt --check` on every edited file — clean. - `git grep "](\.\./\.\./" docs/verification` — no matches remain. - `git diff --stat` — 8 insertions, 8 deletions across 5 files. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable (documentation links). - Package or release metadata impact: none. - Security, privacy, process, or containment review: none. ## Author readiness Human owner: @sathish123m - [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. - [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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:14:12 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-11-01 21:47:10 +00:00

[PR #6401] [MERGED] fix(setup): keep the CLI-only skill choice offered under a client ID #7336

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

No description provided.

Rows
Columns