chore(#2177): add lint-docs-links check; fix all escaping docs/ links#2181
chore(#2177): add lint-docs-links check; fix all escaping docs/ links#2181rh-hemartin wants to merge 1 commit into
Conversation
Site previewPreview: https://9079eac1-site.fullsend-ai.workers.dev Commit: |
Adds hack/lint-docs-links, a pre-commit hook that rejects relative links in docs/ that resolve outside the docs/ tree. Such links are broken on fullsend.sh, which only serves docs/. The error output includes a remediation hint pointing authors to use absolute GitHub URLs. Fixes all 53 pre-existing violations by converting them to absolute github.com/fullsend-ai/fullsend/blob/main/... URLs. Closes #2177. Signed-off-by: Hector Martinez <hemartin@redhat.com>
6c07ab2 to
1c8577f
Compare
|
🤖 Finished Review · ✅ Success · Started 3:13 PM UTC · Completed 3:21 PM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Low
Info
|
ralphbean
left a comment
There was a problem hiding this comment.
LGTM. Link conversions all check out — correct paths, correct blob/tree usage, intra-docs links left alone.
Summary
hack/lint-docs-links, a pre-commit hook that rejects relative links indocs/that resolve outside thedocs/tree.pre-commit-config.yaml(runs on alldocs/**/*.mdfiles)github.com/fullsend-ai/fullsend/blob/main/…URLsLinks that escape
docs/are broken on fullsend.sh, which only serves thedocs/tree.Closes #2177.
Test plan
make lintpasses (lint-docs-links runs as part of pre-commit)./hack/lint-docs-links $(git ls-files docs/ | grep '\.md$')exits 0docs/causes the hook to fail🤖 Generated with Claude Code