Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.MD

GitHub Action for Validating Documentation Links

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.

Usage

This action is written in TypeScript and compiled locally before being pushed to GitHub.

To make changes:

  • Edit the src/index.ts file.
  • Navigate to the script folder cd .github/actions/validate-docs-links
  • Run npm install to install dependencies.
  • Run npm run build to compile code. This will create an updated lib/index.js.
  • Commit and push changes to GitHub.