Skip to content

Conversation

@Miyamura80
Copy link
Owner

Summary

  • Added pytest-check-links as a dev dependency to validate markdown links.
  • Integrated link linting into prek local hooks.
  • Added make lint_links for manual validation and updated make ci to include it.
  • Fixed several broken links in README.md and docs/README.md.
  • Updated AGENTS.md and CLAUDE.md with the new linter command.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 27, 2026

Greptile Overview

Greptile Summary

This PR adds comprehensive markdown link validation to the project using pytest-check-links. The implementation includes:

  • GitHub Actions workflow that runs weekly on a cron schedule to catch link rot over time
  • Pre-commit hook that validates links locally before each commit
  • Makefile target (make lint_links) for manual validation and integration into the CI pipeline
  • Documentation updates in CLAUDE.md and AGENTS.md to reflect the new linting command
  • Link fixes in README.md correcting paths from docs/ to manual_docs/ and adding missing protocol to the Cursor link

The implementation follows the project's patterns for GitHub Actions (using uv for dependency management) and integrates seamlessly with existing CI/CD infrastructure. The weekly scheduled workflow is a good choice for link validation since it can catch external links that break over time without running on every commit.

Confidence Score: 5/5

  • This PR is safe to merge with no issues found
  • The changes are well-structured and follow project conventions. The implementation correctly uses uv for dependency management, properly configures the GitHub Action with appropriate triggers, and integrates cleanly with existing tooling. All documentation has been updated consistently, and the link fixes address real issues. The PR went through multiple commits to resolve CI issues, indicating thorough testing.
  • No files require special attention

Important Files Changed

Filename Overview
.github/workflows/markdown-link-lint.yaml Added new GitHub Action workflow for weekly markdown link validation using scheduled cron job
.pre-commit-config.yaml Added lint-links hook that runs on every commit to check markdown links
Makefile Added lint_links target and integrated it into ci target for comprehensive link checking
CLAUDE.md Updated documentation to include make lint_links command and updated ci target description
pyproject.toml Added pytest-check-links as a dev dependency in dependency-groups
README.md Fixed broken links pointing to docs/ to correct manual_docs/ path and added missing https:// to Cursor link
uv.lock Updated lock file with pytest-check-links dependencies and resolved version conflicts

@Miyamura80 Miyamura80 merged commit 9497900 into main Jan 27, 2026
9 checks passed
@github-actions github-actions bot deleted the feature/lint-links branch January 27, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants