AdobeDocs / AdobeDocs/aep-mobile-sdkdocs

Link validation scripts

Open
#747 0 comments 0 reactions 0 assignees View on GitHub
edgesquad
Dominant language
JavaScript
Stars
6
Forks
54
Avg merge
1d 18h
Merged PRs (30d)
10

Description

### Is there an existing issue for this?

- [x] I have searched the existing issues

### What feature should be added?

Create link validation for internal and external links
Internal: the [remark-validate-links](https://github.com/AdobeDocs/commerce-extensibility/blob/main/package.json#L31) package
* Use [npm script](https://github.com/AdobeDocs/commerce-extensibility/blob/main/package.json#L22) so that our custom [GitHub Action workflow](https://github.com/AdobeDocs/commerce-extensibility/blob/main/.github/workflows/test-pull-request.yml#L82-L83) can run it
External: the [remark-lint-no-dead-urls](https://github.com/AdobeDocs/commerce-extensibility/blob/main/package.json#L30) package

Thanks to @jeff-matthews!

### What is the expected behavior?

Validate links

### How will this feature improve the user experience?

Validate links

### What would a solution for this issue look like?

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with package.json and the referenced .github/workflows/test-pull-request.yml step. Check how the existing npm script is invoked, then review the remark-validate-links and remark-lint-no-dead-urls package references. Done means the workflow runs link validation for both internal and external links.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.