[PR #2787] [CLOSED] docs: align README guide links with relative documentation paths (#2679) #5393

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

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/2787
Author: @udbhav-shrinet
Created: 10/13/2026
Status: ❌ Closed

Base: main ← Head: fix/readme-urls


📝 Commits (2)

  • ce33b3c docs: align README guide links with relative documentation paths (#2679)
  • f505fa2 docs: align translated README guide links with relative documentation paths

📊 Changes

19 files changed (+57 additions, -57 deletions)

View changed files

📝 README.md (+3 -3)
📝 README_ar.md (+3 -3)
📝 README_de.md (+3 -3)
📝 README_es.md (+3 -3)
📝 README_fa.md (+3 -3)
📝 README_fr.md (+3 -3)
📝 README_id.md (+3 -3)
📝 README_it.md (+3 -3)
📝 README_ja.md (+3 -3)
📝 README_ko.md (+3 -3)
📝 README_pl.md (+3 -3)
📝 README_pt-BR.md (+3 -3)
📝 README_ru.md (+3 -3)
📝 README_th.md (+3 -3)
📝 README_tr.md (+3 -3)
📝 README_uk.md (+3 -3)
📝 README_vi.md (+3 -3)
📝 README_zh-TW.md (+3 -3)
📝 README_zh.md (+3 -3)

📄 Description

Summary

Fixes #2679.

In accordance with CONTRIBUTING.md guidance:

"Site navigation lives in docs/.vitepress/config.ts. Keep links to guides relative so they work on GitHub and the website; link to repository files outside docs/ using their full GitHub URLs."

This PR updates the 3 absolute links in the "What you can analyze" table in README.md to their corresponding relative docs paths:

  • Native binaries: https://rea.tools/guides/native/ -> docs/native-investigation.md (matching VitePress config for Native binaries)
  • JavaScript / Electron: https://rea.tools/guides/javascript/ -> docs/javascript-artifact-reconstruction.md (matching VitePress config for JavaScript and Electron)
  • Websites: https://rea.tools/guides/browser/ -> docs/browser-observation.md (matching VitePress config for Browser observation)

Verification

  • Verified all 3 target markdown files exist in docs/.
  • Matches VitePress navigation items defined in docs/.vitepress/config.ts.

🔄 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/2787 **Author:** [@udbhav-shrinet](https://github.com/udbhav-shrinet) **Created:** 10/13/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `fix/readme-urls` --- ### 📝 Commits (2) - [`ce33b3c`](https://github.com/morluto/rea/commit/ce33b3c32da3c628e3e9fc8842b159aa0b60ff9f) docs: align README guide links with relative documentation paths (#2679) - [`f505fa2`](https://github.com/morluto/rea/commit/f505fa2564681a3706525ed435f656ebd05a5cec) docs: align translated README guide links with relative documentation paths ### 📊 Changes **19 files changed** (+57 additions, -57 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+3 -3) 📝 `README_ar.md` (+3 -3) 📝 `README_de.md` (+3 -3) 📝 `README_es.md` (+3 -3) 📝 `README_fa.md` (+3 -3) 📝 `README_fr.md` (+3 -3) 📝 `README_id.md` (+3 -3) 📝 `README_it.md` (+3 -3) 📝 `README_ja.md` (+3 -3) 📝 `README_ko.md` (+3 -3) 📝 `README_pl.md` (+3 -3) 📝 `README_pt-BR.md` (+3 -3) 📝 `README_ru.md` (+3 -3) 📝 `README_th.md` (+3 -3) 📝 `README_tr.md` (+3 -3) 📝 `README_uk.md` (+3 -3) 📝 `README_vi.md` (+3 -3) 📝 `README_zh-TW.md` (+3 -3) 📝 `README_zh.md` (+3 -3) </details> ### 📄 Description ## Summary Fixes #2679. In accordance with CONTRIBUTING.md guidance: > "Site navigation lives in `docs/.vitepress/config.ts`. Keep links to guides relative so they work on GitHub and the website; link to repository files outside `docs/` using their full GitHub URLs." This PR updates the 3 absolute links in the "What you can analyze" table in `README.md` to their corresponding relative docs paths: - **Native binaries**: `https://rea.tools/guides/native/` -> `docs/native-investigation.md` (matching VitePress config for Native binaries) - **JavaScript / Electron**: `https://rea.tools/guides/javascript/` -> `docs/javascript-artifact-reconstruction.md` (matching VitePress config for JavaScript and Electron) - **Websites**: `https://rea.tools/guides/browser/` -> `docs/browser-observation.md` (matching VitePress config for Browser observation) ## Verification - Verified all 3 target markdown files exist in `docs/`. - Matches VitePress navigation items defined in `docs/.vitepress/config.ts`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-31 01:06:17 +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#5393
No description provided.