Enable lychee link checking and fix outdated documentation links - #1131
Open
vdstrizhkova wants to merge 6 commits into
Open
Enable lychee link checking and fix outdated documentation links#1131vdstrizhkova wants to merge 6 commits into
vdstrizhkova wants to merge 6 commits into
Conversation
vdstrizhkova
requested review from
TessFerrandez,
nyouens and
shiranr
as code owners
June 19, 2026 14:03
There was a problem hiding this comment.
Pull request overview
This PR enables automated link checking (Lychee via MegaLinter) and updates documentation/configuration links across the playbook to resolve broken/outdated references.
Changes:
- Expanded
lychee.tomlexclusions to reduce CI flakiness from sites that block automation or time out. - Enabled
SPELL_LYCHEEin MegaLinter. - Updated numerous documentation links (Grafana/Loki, sustainability, code review recipes, contributor guidance, templates).
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
lychee.toml |
Adds additional exclusions for known-bad-to-crawl but valid-in-browser sites. |
docs/source-control/component-versioning.md |
Updates Angular commit conventions reference link. |
docs/observability/tools/loki.md |
Updates Grafana Loki “getting started” documentation link. |
docs/observability/observability-databricks.md |
Replaces deleted Spark monitoring repo link with Microsoft monitoring guidance. |
docs/non-functional-requirements/privacy/data-handling.md |
Updates Limited DPA link to a direct PDF. |
docs/developer-experience/client-app-inner-loop.md |
Updates JsonServer reference to the maintained project. |
docs/design/sustainability/sustainable-engineering-principles.md |
Updates sustainability principle links to Green Software Foundation learning resources. |
docs/design/sustainability/README.md |
Updates an eco-mode resource link in the sustainability checklist table. |
docs/design/diagram-types/sequence-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/README.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/deployment-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/component-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/design/diagram-types/class-diagrams.md |
Replaces a broken “Drawing manually” resource link. |
docs/code-reviews/recipes/markdown.md |
Updates plain-language guidance link. |
docs/code-reviews/recipes/java.md |
Updates Azure Java SDK checkstyle configuration reference link. |
docs/automated-testing/synthetic-monitoring-tests/README.md |
Updates New Relic synthetics link. |
docs/agile-development/advanced-topics/collaboration/pair-programming-tools.md |
Updates Live Share documentation links to learn.microsoft.com. |
CONTRIBUTING.md |
Updates plain-language guidance link. |
.projector/workItemTemplates/kubernetes-at-the-edge.yml |
Updates Calico Windows limitations link to Tigera docs. |
.projector/workItemTemplates/engineering-fundamentals.yml |
Updates working agreement link path. |
.mega-linter.yml |
Enables SPELL_LYCHEE linter. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
added 4 commits
July 16, 2026 09:16
- align wording and tone across observability, security, code-review, and other docs - fix outdated/broken external links and dead references - add cspell terms, gitignore/gitattributes, and mkdocs workflow action bumps 📝 - Generated by Copilot
- lychee surfaces a backlog of pre-existing broken/blocked external links - keep it disabled (as in the source PR) until that backlog is triaged 🔧 - Generated by Copilot
- add AI-assisted engineering hub (docs/ai-assisted-engineering/README.md) - add generative-AI and agentic systems guidance, including HVE references 🤖 - Generated by Copilot
- add Start Here section with role on-ramps and project kickoff checklist - add Non-Functional Requirements section and update navigation (.pages, READMEs) - rename docs/design/readme.md to README.md; remove superseded first-week page 🗂️ - Generated by Copilot
vdstrizhkova
force-pushed
the
feat/lychee-link-check
branch
3 times, most recently
from
July 17, 2026 08:48
5753447 to
3d45d77
Compare
- enable SPELL_LYCHEE in MegaLinter and configure lychee.toml (accept 2xx/403/429, exclude mail) - fix broken links: Spring Cloud Contract, Git Bash for Windows, and DPA reference - refresh outdated diagram, sustainability, observability, and source-control links 🔗 - Generated by Copilot
vdstrizhkova
force-pushed
the
feat/lychee-link-check
branch
from
July 17, 2026 12:24
3d45d77 to
dac3f3c
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 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.
Pull Request Template
What are you trying to address
Enables the lychee link checker in CI and fixes the broken/outdated links it surfaces, keeping the playbook's links healthy.
This PR is stacked on #1133 and #1134 (AI/HVE additions and the navigation restructure). It builds on top of them so the newly added pages and their link targets exist when the checker runs. Until #1133 and #1134 merge, this PR's diff also includes their changes; it reduces to the lychee-only delta once they land (or after a rebase onto
main).Enable link checking
SPELL_LYCHEEin.mega-linter.yml.lychee.toml: accept2xx,403, and429(hosts that exist but block/throttle CI bots), excludemailto:(not verifiable via SMTP in CI), and add exclusions for sites with bot-protection or expired certificates.Fix outdated links
Validation
ftp://).Checklist
READY TO PR? Use the check-list below to ensure your branch is ready for PR.