ci(docs): 🔗 add docs link check - #53
Merged
Merged
Conversation
Add lychee-based docs link checking for both source MDX (internal links) and built HTML output (including external links), and wire both checks into the documentation workflow. Update docs commands in README accordingly. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Roberto Di Remigio Eikås <robertodr@users.noreply.github.com>
Member
|
@matteoacrossi are you still interested in getting this merged? |
…d settings.json - Exclude `/benchmarks/*` paths from lychee (public/ assets served at runtime) - Fix `settings.json` relative link to proper GitHub URL Assisted-by: GitHubCopilotCodingAgent:claude-sonnet-5 Co-authored-by: robertodr <3708689+robertodr@users.noreply.github.com>
github-actions
Bot
added
documentation
Remove source-level docs link checking from justfile and CI, and keep a single lychee pass on built docs HTML. Also simplify README docs commands to the standalone check-doc-links recipe. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
matteoacrossi
changed the title
matteoacrossi
marked this pull request as ready for review
August 20, 2026 18:37
matteoacrossi
requested review from
diagonal-hamiltonian,
fpietra and
ludmilaasb
as code owners
August 20, 2026 18:37
matteoacrossi
marked this pull request as draft
August 20, 2026 18:37
Signed-off-by: Matteo AC Rossi <9745862+matteoacrossi@users.noreply.github.com>
Member
Author
|
@copilot the three errors raised by lychee in the CI are false positives, add them to the ignore list. |
… check - settings.json GitHub URL: 404 until this branch merges to main - localhost:3000: dev-server example URL, never reachable in CI - link.aps.org: APS journal blocks automated crawlers with 403 Assisted-by: GitHubCopilotCodingAgent:claude-sonnet-5 Co-authored-by: matteoacrossi <9745862+matteoacrossi@users.noreply.github.com>
Contributor
🤖 AI text below 🤖 Done in the latest commit. Added all three to the
|
matteoacrossi
marked this pull request as ready for review
August 20, 2026 19:45
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #53 +/- ##
=======================================
Coverage 97.70% 97.70%
=======================================
Files 14 14
Lines 742 742
Branches 98 98
=======================================
Hits 725 725
Misses 12 12
Partials 5 5
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Docs preview: https://pr-53.monoprop-docs.pages.dev |
Updated accepted response codes to include 403 for better handling of websites that block crawlers. Signed-off-by: Matteo AC Rossi <9745862+matteoacrossi@users.noreply.github.com>
matteoacrossi
enabled auto-merge (squash)
August 21, 2026 08:27
matteoacrossi
changed the title
diagonal-hamiltonian
previously approved these changes
Aug 21, 2026
Signed-off-by: Matteo AC Rossi <9745862+matteoacrossi@users.noreply.github.com>
diagonal-hamiltonian
approved these changes
Aug 21, 2026
|
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
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.
Why
Add a link checking step to the Documentation CI, using Lychee.
What changed
docs/out/**/*.html) with external links enabled.check-doc-linksrecipe injustfile.README.mddocs commands to match the one-check flow.Notes for reviewers
check-doc-linksexpectsdocs/outto already exist (for example afterjust build-docs).