This action ensures that internal links in .mdx files in the /docs/ directory are valid. It runs on every pull request that includes changes to these files.
The action is triggered by the workflow defined in .github/workflows/validate-docs-links.yml.
This action is written in TypeScript and compiled locally before being pushed to GitHub.
To make changes:
- Edit the
src/index.tsfile. - Navigate to the script folder
cd .github/actions/validate-docs-links - Run
npm installto install dependencies. - Run
npm run buildto compile code. This will create an updatedlib/index.js. - Commit and push changes to GitHub.