morluto/rea

Fork 0

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

[GH-ISSUE #5030] [Feature] Add VitePress dead-link verification to CI docs workflow #3093

New issue

Closed

opened 2026-10-31 00:36:31 +00:00 by bsakaguchi · 3 comments

bsakaguchi commented

2026-10-31 00:36:31 +00:00

Owner

Originally created by @prasad2512 on GitHub (Oct 18, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/5030

Before submitting

I searched the open and closed issues and pull requests for a related proposal.
I understand the contribution scope must be reviewed before integration; open questions are welcome here.
This request does not include credentials, private samples, or sensitive target data.

Area

Documentation

Current limitation

Currently,
pm run docs:check\ passes in CI while
px vitepress build docs\ can fail with dead links when relative links cross directory boundaries or point outside \docs/. Because the full VitePress build is primarily executed in the \pages.yml\ deployment workflow, dead markdown links can pass regular PR CI checks unnoticed.

Desired outcome and success criteria

Add a dead-link verification step (or run \itepress build docs) as part of the PR CI documentation validation job, ensuring that dead links are caught automatically during pull request review.

Expected interaction with targets

No target interaction (documentation or usability only)

Verification available so far

I can suggest a sample or manual check

Originally created by @prasad2512 on GitHub (Oct 18, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/5030 ### Before submitting - [x] I searched the open and closed issues and pull requests for a related proposal. - [x] I understand the contribution scope must be reviewed before integration; open questions are welcome here. - [x] This request does not include credentials, private samples, or sensitive target data. ### Area Documentation ### Current limitation Currently, \ pm run docs:check\ passes in CI while \ px vitepress build docs\ can fail with dead links when relative links cross directory boundaries or point outside \docs/\. Because the full VitePress build is primarily executed in the \pages.yml\ deployment workflow, dead markdown links can pass regular PR CI checks unnoticed. ### Desired outcome and success criteria Add a dead-link verification step (or run \itepress build docs\) as part of the PR CI documentation validation job, ensuring that dead links are caught automatically during pull request review. ### Expected interaction with targets No target interaction (documentation or usability only) ### Verification available so far I can suggest a sample or manual check

bsakaguchi closed this issue

2026-10-31 00:36:31 +00:00

bsakaguchi commented

2026-10-31 00:36:32 +00:00

Author

Owner

@hitendra1851 commented on GitHub (Oct 18, 2026):

Hi @prasad2512, I can confirm this on current main: npx vitepress build docs fails with 6 dead links, all relative links from docs/ into experiments/ (e.g. apktool-resource-analysis.md, jeb-analysis.md, testing.md, and three verification/* pages), while npm run docs:check passes. If you're not planning to work on it, I'd like to take it: convert those links to full GitHub URLs as CONTRIBUTING.md asks, and add the VitePress build to the existing Docs Generation CI job so new dead links fail PR checks. Happy to step back if you already have a branch.

@hitendra1851 commented on GitHub (Oct 18, 2026): Hi @prasad2512, I can confirm this on current main: `npx vitepress build docs` fails with 6 dead links, all relative links from `docs/` into `experiments/` (e.g. `apktool-resource-analysis.md`, `jeb-analysis.md`, `testing.md`, and three `verification/*` pages), while `npm run docs:check` passes. If you're not planning to work on it, I'd like to take it: convert those links to full GitHub URLs as CONTRIBUTING.md asks, and add the VitePress build to the existing Docs Generation CI job so new dead links fail PR checks. Happy to step back if you already have a branch.

bsakaguchi commented

2026-10-31 00:36:32 +00:00

Author

Owner

@prasad2512 commented on GitHub (Oct 18, 2026):

Hi @hitendra1851, thanks for confirming! Please go ahead and take it up. Note that PR #5028 and draft #4769 already address several of the relative link fixes, so integrating
px vitepress build docs\ into the CI docs workflow will be super valuable. Looking forward to reviewing your PR once it's up!

@prasad2512 commented on GitHub (Oct 18, 2026): Hi @hitendra1851, thanks for confirming! Please go ahead and take it up. Note that PR #5028 and draft #4769 already address several of the relative link fixes, so integrating \ px vitepress build docs\ into the CI docs workflow will be super valuable. Looking forward to reviewing your PR once it's up!

bsakaguchi commented

2026-10-31 00:36:33 +00:00

Author

Owner

@morluto commented on GitHub (Oct 23, 2026):

Fixed on main in github.com/morluto/rea@91f06f55a3. The PR CI Documentation job now runs npm run docs:build after docs:check. docs:build runs vitepress build docs, so selected documentation PRs render and validate page links during CI rather than only during Pages deployment.

Verified against the full issue and current source. The published tree also retains passing docs:check and docs:build receipts. This closes the documentation/help/CI-configuration scope; no new provider runtime verification is claimed.

@morluto commented on GitHub (Oct 23, 2026): Fixed on main in https://github.com/morluto/rea/commit/91f06f55a32968b47b825f8373616ce9e4f9a02a. The PR CI Documentation job now runs npm run docs:build after docs:check. docs:build runs vitepress build docs, so selected documentation PRs render and validate page links during CI rather than only during Pages deployment. Verified against the full issue and current source. The published tree also retains passing docs:check and docs:build receipts. This closes the documentation/help/CI-configuration scope; no new provider runtime verification is claimed.

bsakaguchi referenced this issue

2026-10-31 01:07:58 +00:00

[PR #3093] [CLOSED] test(electron): verify preload coverage across the retention boundary #5611

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

No description provided.

Rows
Columns