Repository navigation
ci(links): resolve Docusaurus root-relative links in lychee - #732
Merged
Merged
Conversation
|
All contributors have signed the CLA. ✅ |
The weekly link check reported 36 "Cannot resolve root-relative link" errors for docs pages that link to /img/... static assets and /<section>/<page> doc routes. Docusaurus resolves both (and its build already throws on broken internal links), but lychee had no root dir. Point --root-dir at docs/static and remap doc-section routes to docs/docs/<section>/<page> with md/mdx fallback extensions, so lychee now verifies those targets exist rather than erroring. Also ignore the four OTP GraphQL endpoints in the schema NOTICE: they accept POST queries only, so GET returns 405/500 by design. Refs #247 Claude-Session: https://claude.ai/code/session_017DEL8C49cYr4sPqU7EJgCR
Medformatik
force-pushed
the
claude/confident-volta-2tlyvq
branch
from
November 1, 2026 16:36
4c88d9e to
89f4b6b
Compare
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What changed and why
The weekly link check reports 36
Cannot resolve root-relative linkerrors in #247. They come fromdocs/docs/developer/map-comparison-baseline.md, which links to/img/...static assets, and fromdocs/docs/overview/introduction.md, which links to/<section>/<page>doc routes. Docusaurus resolves both kinds of link, and its build already throws on broken internal links. Lychee had no root directory, so it couldn't resolve them..github/workflows/links.yml: sets--root-dirtodocs/staticand remaps doc-section routes (administration,developer,features,guides,install,overview,releases) todocs/docs/<section>/<page>, with--fallback-extensions md,mdx. Lychee now checks that these targets exist instead of erroring..lycheeignore: ignores the four OTP GraphQL endpoints listed inpackages/otp-client/schema/NOTICE.md. They accept POST queries only, so a plain GET returns 405/500 by design.Related work
Refs #247. This PR does not close the issue. Seven reports remain, and they look like upstream or transient problems, so I didn't ignore them:
docs.openweather.co.uk(2): the site's SSL certificate had expired.edeka.de(1) anddigitransit.fi(2): 403, possibly bot blocking, which I could not confirm.changesets.dev: timeout.Verification
I ran lychee v0.24.2, built locally, in
--offlinemode, so these checks cover local links only:/img/...asset and a missing/overview/...page are both still reported as errors..lycheeignore:lychee --dumpconfirms the four OTP endpoints are excluded and the digitransit links are still checked.argsvalue is as intended.Not performed: external link checks (this environment has no general outbound network) and a real run of the workflow on GitHub Actions. After merge, use the Link check workflow's
workflow_dispatchtrigger to confirm.Release and upgrade impact
None. This only changes CI configuration.