docs: fix case-sensitive RS BOM links breaking the link check on main - #61
Merged
ZhuYaoHui1998 merged 1 commit intoAug 22, 2026
Merged
Conversation
The weekly link check has been failing on main since 2026-08-17. Two links, in README_Fr.md and README_JP.md, target ./hardware/reBot_B601_RS/readme.md, but that directory holds README.md in uppercase — the RS folder uses README.md while the DM folder beside it uses readme.md. GitHub serves paths case-sensitively, so both 404. These slipped through review in Seeed-Projects#58 because that verification ran on a case-insensitive Windows filesystem, where readme.md resolves to README.md and reports as fine. The CI job runs on ubuntu-latest, which is why it caught them on its first scheduled run. Closes Seeed-Projects#60 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Closes #60
What this changes
Two links, one line each:
README_Fr.md:159./hardware/reBot_B601_RS/readme.md./hardware/reBot_B601_RS/README.mdREADME_JP.md:158./hardware/reBot_B601_RS/readme.md./hardware/reBot_B601_RS/README.mdThe RS hardware folder holds
README.mdin uppercase; the DM folder beside it uses lowercasereadme.md. GitHub serves repository paths case-sensitively, so both links 404 today for anyone reading the French or Japanese README and clicking through to the RS bill of materials.This is what turned the weekly link check red on
mainin run 32002320359 — the only two errors out of 443 unique links.Why #58 missed it
Worth stating plainly, since it bears on how much weight to give that PR's verification: the checker I ran to confirm "0 broken relative links" ran on Windows, whose filesystem is case-insensitive.
hardware/reBot_B601_RS/readme.mdresolves toREADME.mdthere and reports as a working link. Onubuntu-latestit does not. So the relative-path claim in #58 was sound for missing files but blind to case — and the CI job added in that same PR caught it on its first scheduled run, which is a reasonable argument for the job's existence.Verification
hardware/reBot_B601_RS/README.md.After this merges, the next scheduled
Check Documentation Linksrun (Mondays, 06:00 UTC) should go green.One suggestion, not included here
This failure sat red on
mainfrom Monday to Thursday without action. A scheduled check nobody looks at is close to no check. lychee documents anif: failure()step usingpeter-evans/create-issue-from-filethat turns a scheduled failure into an issue. I have deliberately left it out of this PR — it is a separate decision about how noisy you want CI to be, and I would rather you choose it than inherit it. Say the word and I will send it.🤖 Generated with Claude Code