docs(links): add lychee local link-check baseline (#2150) - #2165
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2165 +/- ##
========================================
Coverage 84.68% 84.69%
========================================
Files 351 351
Lines 29657 29657
Branches 29657 29657
========================================
+ Hits 25116 25117 +1
Misses 4189 4189
+ Partials 352 351 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
🟡 Changes recommended
The README still references an undefined db_bench_wf/db_bench_wf_b badge target, which breaks rendering and should be fixed before merge.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR establishes a deterministic, offline baseline for local Markdown link + fragment checking using lychee, and repairs a large set of broken local documentation links/anchors across the repository. It also records the baseline evidence and adds a follow-up issue specification for later enforcement plus advisory online checks.
Changes:
- Add
lychee.tomlconfigured for offline, full fragment validation, with a narrow exclusion for historical closed issue specs. - Fix broken local file/anchor links across maintained docs, ADRs, issue specs, skills, and test documentation.
- Add baseline evidence documentation (
link-check-report.md) and the follow-up enforcement specification for #2162.
File summaries
| File | Description |
|---|---|
tests/AGENTS.md |
Fix relative link depth for referenced issue spec. |
README.md |
Switch workflow badge targets to canonical GitHub Actions URLs. |
packages/tracker-client/README.md |
Fix license/doc link depths to repository root. |
packages/torrent-repository-benchmarking/README.md |
Fix license link to repository root. |
packages/swarm-coordination-registry/README.md |
Fix license link to repository root. |
packages/rest-api-client/README.md |
Fix license/doc link depths to repository root. |
lychee.toml |
Add offline + full-fragment lychee baseline config with closed-issues exclusion. |
docs/security/analysis/reports/README.md |
Fix relative path to root SECURITY.md. |
docs/profiling.md |
Fix benchmarking anchor link to updated heading. |
docs/issues/open/2162-enforce-lychee-and-schedule-external-link-checks/ISSUE.md |
Add follow-up issue spec for enforcement + advisory online checks. |
docs/issues/open/2150-add-lychee-link-checker/link-check-report.md |
Add baseline report describing findings and final clean run. |
docs/issues/open/2150-add-lychee-link-checker/ISSUE.md |
Update #2150 spec progress/acceptance criteria to reflect completion and references. |
docs/issues/open/1768-refactor-update-dependencies-skill-automation.md |
Fix split-issue spec links to moved/closed location. |
docs/issues/open/1669-overhaul-packages/workspace-coupling-report-proposed-merge.md |
Fix source report link target. |
docs/issues/open/1669-overhaul-packages/workspace-coupling-report-2026-06-10.md |
Repair various internal links/fragments and replace stale draft-spec links with canonical issue URLs. |
docs/issues/open/1669-overhaul-packages/EPIC.md |
Repair ADR/spec links and replace stale spec targets with canonical issue URLs. |
docs/issues/open/1669-overhaul-packages/DECISIONS.md |
Repair internal links and update supporting-artifact paths for moved specs. |
docs/issues/open/1419-allow-multiple-integration-tests-at-main-app-level/ISSUE.md |
Fix relative paths and update prereq bug spec links to closed location. |
docs/issues/open/1419-allow-multiple-integration-tests-at-main-app-level/investigation-registar-and-health-check.md |
Update referenced issue spec links to closed location. |
docs/issues/open/1347-overhaul-packages-testing/EPIC.md |
Fix relative links to sub-issue specs/evidence. |
docs/issues/drafts/increase-main-app-integration-test-coverage.md |
Replace removed/historical local test links with canonical GitHub URLs. |
docs/issues/drafts/1669-01-establish-baseline-analysis.md |
Fix coupling report link target naming. |
docs/benchmarking.md |
Update aquatic guide links to closed issue location. |
docs/architecture/events.md |
Update issue spec reference to closed location. |
docs/adrs/20260822094338_adopt_secrecy_for_sensitive_values.md |
Update issue spec references to closed location. |
docs/adrs/20260728115400_define_registar_as_runtime_service_registry.md |
Update feature spec reference to closed location. |
docs/adrs/20260629000000_adopt_independent_package_versioning.md |
Replace local spec reference with canonical issue URL. |
docs/adrs/20260617093046_reject_wildcard_external_ip.md |
Replace local spec reference with canonical issue URL. |
docs/adrs/20260603000000_keep_unit_tests_inside_container_build.md |
Update issue spec reference to closed location. |
docs/adrs/20260527175600_keep_protocol_and_domain_types_decoupled.md |
Update subissue spec reference to closed location. |
docs/adrs/20260512102000_define_tracker_client_peer_id_convention.md |
Update issue spec reference to closed location. |
docs/adrs/20260429000000_keep_database_as_aggregate_supertrait.md |
Update issue spec/epic references to closed location. |
contrib/dev-tools/experiments/sccache-docker/04-gha-workflow-experiments/REPORT.md |
Update experiment links to archived/closed issue artifacts. |
console/tracker-client/README.md |
Fix license/doc link depths to repository root. |
.github/skills/dev/rust-code-quality/fix-clippy-warnings/SKILL.md |
Fix related-skill relative paths. |
.github/skills/dev/planning/create-refactor-plan/SKILL.md |
Fix template link depth. |
.github/skills/dev/planning/create-issue/SKILL.md |
Fix template link depths. |
.github/skills/dev/planning/create-adr/SKILL.md |
Fix template/example link depths. |
.github/skills/dev/planning/cleanup-completed-issues/SKILL.md |
Fix lifecycle doc link depths. |
.github/skills/dev/git-workflow/run-linters/SKILL.md |
Fix related-skill relative paths. |
.github/skills/add-new-skill/SKILL.md |
Replace stale local references with canonical external spec links. |
Review details
- Files reviewed: 41/41 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
e7b5119 to
5a8ab03
Compare
5a8ab03 to
01b6305
Compare
|
ACK 01b6305 |
Summary
lychee.tomlfor deterministic offline local Markdown file and fragment checks.Files and scope
lychee.tomldocs/issues/open/2150-add-lychee-link-checker/docs/issues/open/2162-enforce-lychee-and-schedule-external-link-checks/Validation
share/**/*.mdinput emits the expected non-fatal unmatched-input warning.TORRUST_GIT_HOOKS_LOG_DIR=.tmp ./contrib/dev-tools/git/hooks/pre-commit.shCloses #2150