feat:Add markdown link checker + PR template doc-update reminder#697
Closed
GodWar9 wants to merge 1 commit into
Closed
feat:Add markdown link checker + PR template doc-update reminder#697GodWar9 wants to merge 1 commit into
GodWar9 wants to merge 1 commit into
Conversation
- Add markdown-link-check to pre-commit config - Add PR template checklist item for CONTRIBUTING.md/AGENTS.md updates - Fix broken links found by the new checker Closes mllam#654
Collaborator
|
Duplicate of #655 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR adds two lightweight mechanisms to keep CONTRIBUTING.md and AGENTS.md from rotting, as requested in #654.
Changes
Add markdown-link-check to pre-commit
markdown-link-checkhook to.pre-commit-config.yamlAdd PR template reminder
.github/pull_request_template.md:Additional Fixes
While running the new link checker, I found and fixed several broken links in the existing documentation:
README.MD→README.mdin PR templatepyg.org→https://github.com/pyg-team/pytorch_geometrickutt.to/mllamlink#graph-based-neural-weather-prediction...)danra.datastore.yamlpath (typo + missing folder) / kept as plain textCloses #654