Add GitHub workflow to validate documentation links and check for broken URLs #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👋 Thanks for contributing @elbruno! We will review the pull request and get back to you soon. |
There was a problem hiding this comment.
PR Overview
This PR adds a new GitHub workflow for validating documentation links and checking for broken URLs.
- Introduces three jobs to check broken paths, locale-specific URL issues, and broken URLs.
- Utilizes the john0isaac/action-check-markdown action to perform validations on markdown files.
Reviewed Changes
| File | Description |
|---|---|
| .github/workflows/validate-documentation-links.yml | Adds a workflow for validating markdown documentation links. |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
.github/workflows/validate-documentation-links.yml:30
- [nitpick] The guide URL on line 30 uses a lowercase file extension (CONTRIBUTING.md) while the later jobs reference CONTRIBUTING.MD. Consider standardizing the file extension casing across all jobs to ensure consistency, especially if the repository is hosted on a case-sensitive file system.
guide-url: 'https://github.com/microsoft/Phi-3CookBook/blob/main/CONTRIBUTING.md'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add GitHub workflow to validate documentation links and check for broken URLs