zed icon indicating copy to clipboard operation
zed copied to clipboard

ci: Check for broken links

Open thomas-zahner opened this issue 6 months ago • 4 comments

This PR fixes some broken links that where found using lychee as discussed today with @JosephTLyons and @nathansobo at the RustNL hackathon. Using lychee-action we can scan for broken links daily to prevent issues in the future. There are still 6 broken links that I didn't know how to fix myself. See https://github.com/thomas-zahner/zed/actions/runs/15075808232 for details.

Missing images

Errors in ./docs/src/channels.md

    [ERROR] file:///home/runner/work/zed/zed/docs/.gitbook/assets/channels-3.png | Cannot find file
    [ERROR] file:///home/runner/work/zed/zed/docs/.gitbook/assets/channels-1.png | Cannot find file
    [ERROR] file:///home/runner/work/zed/zed/docs/.gitbook/assets/channels-2.png | Cannot find file

These errors are showing up as missing images on https://zed.dev/docs/channels I tried to search the git history to see when or why they were deleted but didn't find anything.

./crates/assistant_tools/src/edit_agent/evals/fixtures/zode/prompt.md

There are three errors in that file. I don't fully understand how these issues were caused historically. Technically it would be possible to ignore the files but of course if possible we should address the issues.

Release Notes:

  • N/A

thomas-zahner avatar May 16 '25 19:05 thomas-zahner

Thanks for following through on this!

probably-neb avatar May 17 '25 10:05 probably-neb

Hi @thomas-zahner! We require contributors to sign the Zed Contributor license agreement. Could you please sign the Zed CLA? Since clabot has been acting up, please comment here so we can manually verify. Thanks.

notpeter avatar May 17 '25 16:05 notpeter

@probably-neb Sure, no problem.

thomas-zahner avatar May 17 '25 16:05 thomas-zahner

@notpeter Ah I didn't realise this was necessary. I accepted it just now.

thomas-zahner avatar May 17 '25 16:05 thomas-zahner

Hey @thomas-zahner, I'm going to get this over the finish line by integrating with my recent addition of a docs validation step in CI. Thanks for getting this all setup!

probably-neb avatar Jun 06 '25 07:06 probably-neb

Note, this test gives a false positive when committing documentation that links to new source files in the same commit. Example run failure.

Basically I added script/freebsd to the repo and then added documentation which links to that file. This is likely are a rare situation and much less common that committing bad links with typos. :P

Anyways, thanks for implementing this @thomas-zahner!

P.S. That build failure did not stop auto-merge. @probably-neb Let's pair on a fix on Monday.

notpeter avatar Jun 06 '25 23:06 notpeter

Fix for not requiring check_docs to pass as pre-req for automerge here:

  • https://github.com/zed-industries/zed/pull/32470

notpeter avatar Jun 10 '25 16:06 notpeter

Hey @thomas-zahner, I'm going to get this over the finish line by integrating with my recent addition of a docs validation step in CI. Thanks for getting this all setup!

@probably-neb @notpeter Sure, I'm glad I could help :+1: Thank you for polishing and merging it.

thomas-zahner avatar Jun 10 '25 20:06 thomas-zahner