Taylor/update url checker #994
Open
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the GitHub workflow that checks for broken documentation URLs by adding a path filter to only trigger on markdown file changes and updating the workflow name for clarity.
- Updated workflow name to better reflect its purpose of detecting moves/deletions
- Added path filter to only trigger when markdown files are modified
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
🔍 Documentation URL Checker This PR modifies documentation files in ways that could potentially create broken links. Renamed/Moved files: 🚨 Please review these changes carefully 🚨 If not handled properly, broken links (404 errors) could appear. To maintain a smooth user experience, consider:
|
nhussein11
reviewed
Sep 17, 2025
|
🔍 Documentation & Navigation Checker This PR modifies Navigation file changes: 🚨 Please verify:
🚨 If not handled properly, broken links (404 errors) could appear. To maintain a smooth user experience, consider:
|
eshaben
reviewed
Sep 29, 2025
There was a problem hiding this comment.
I'm looking at this comment: #994 (comment)
And I think this could get out of hand quite quickly if there are several pages that have been moved. Can we remove some of the extra text in the code element and just print the name of the file that was deleted/renamed? I don't think we need to see the contents of the .nav.yml file along with the diff command and all that.
Co-authored-by: Erin Shaben <[email protected]>
|
🔍 Documentation & Navigation Checker This PR modifies Modified Markdown files: 🚨 Please verify:
🚨 If not handled properly, broken links (404 errors) could appear. To maintain a smooth user experience, consider:
|
Telucero
force-pushed
the
taylor/update-url-checker
branch
from
7e80ffc to
e3f072a
Compare
|
🔍 Documentation & Navigation Checker This PR modifies Deleted Markdown files: Navigation file changes: 🚨 Please verify:
🚨 If not handled properly, broken links (404 errors) could appear. Consider:
|
…hecker # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
|
🔍 Documentation & Navigation Checker This PR modifies Renamed Markdown files: Navigation file changes: 🚨 Please verify links remain valid and any deleted or renamed entries are handled. |
|
@Telucero I think just having something like this: Renamed Markdown files: Deleted Markdown files: Then get rid of the .nav.yml stuff because I think it's just extra noise. Anything that would have shown up in the .nav.yml part should show up in either the renamed or deleted section. |
|
The goal of this script is to throw up a flag so we can make sure we're creating redirects and updating internal links for these pages. It might be helpful to check out the redirect script to see how we find the files that need to updated there: https://github.com/papermoonio/polkadot-mkdocs/blob/main/scripts/update_redirects.py#L123C1-L124C1 |
|
Deleted Markdown files: Renamed Markdown files: |
|
Deleted Markdown files: Renamed Markdown files: |
|
Its because in this branch the .aI directory doesn't exist, so its listing them as deleted. |
eshaben
reviewed
Oct 31, 2025
There was a problem hiding this comment.
haha sorry I should have been more specific, I think we still need some sort of simple messaging like was there before def with an emoji to try to catch peoples attn:
🚨 Please verify links remain valid and any deleted or renamed entries are handled.
Maybe we could do a little check list type thing at the end:
- [ ] Update internal links
- [ ] Add redirects
- [ ] Remove or update corresponding snippets and images
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.
This workflow compares the PR branch against master and looks only for Markdown files that were deleted or renamed/moved. If it finds any, it posts a warning comment on the pull request so reviewers know these changes could break documentation URLs. If no files are deleted or renamed, the workflow runs silently and does not comment.