Add lychee link-check workflow and update documentation links - #8
Conversation
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a1c0705e6c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| --scheme http | ||
| --scheme https |
There was a problem hiding this comment.
Include local links in the checked schemes
Restricting Lychee to http and https skips relative documentation links because those are handled as file links; Lychee's --scheme documentation states that it checks only links with the specified schemes. This leaves repository-local targets unvalidated, including the currently broken docs/curator-cli.gif reference at docs/README_zh.md:42, which resolves to the nonexistent docs/docs/curator-cli.gif, so the new job can pass despite broken documentation links.
Useful? React with 👍 / 👎.
Motivation
docsstructure.Description
.github/workflows/lychee-link-check.yamlthat runslycheeverse/lychee-action@v2onpull_requestandpushtomainwith options like--cache,--max-cache-age 7d,--accept 200,403,429, and outputs results to./lychee-out.mdin Markdown format usinglycheeVersion: v0.23.0.README.mdto adjust tutorial and API reference links tohttps://docs.bespokelabs.ai/bespoke-curator/data-curation-recipesandhttps://docs.bespokelabs.ai/bespoke-curator/api-reference.docs/README_zh.mdto keep English and Chinese docs consistent.Testing
pull_requestandpushevents and will report link-check results.lycheejob is set to fail on broken links viafail: trueand will produce a job summary and Markdown output when it runs.Codex Task