Docs: Add external link validation with lychee - #4707
Open
aravindtga wants to merge 2 commits into
Open
Conversation
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
aravindtga
force-pushed
the
external-link-validation
branch
from
August 17, 2026 13:31
3b8a8a0 to
d9b2120
Compare
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
aravindtga
force-pushed
the
external-link-validation
branch
from
August 18, 2026 11:02
d9b2120 to
25455cf
Compare
aravindtga
marked this pull request as ready for review
August 18, 2026 11:05
aravindtga
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
August 18, 2026 11:05
dosubot
Bot
added
size:L
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds automated external link checking for the documentation and updates several outdated doc URLs to reduce link rot.
Changes:
- Add lychee configuration and a Makefile target for external link validation.
- Add a weekly GitHub Actions workflow to verify spelling and check external links.
- Update multiple documentation links (Docker docs, Kubernetes guidelines, Netlify badge, Dosu URL, etc.).
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| documentation/lychee.toml | Adds lychee config (schemes, root dir, excludes, host throttling) for consistent link checking. |
| documentation/layouts/partials/footer.html | Updates Netlify badge image URL used in the site footer. |
| documentation/content/en/reference/schema/crd-status-convention/_index.md | Updates Kubernetes API conventions link from master to main. |
| documentation/content/en/reference/schema/config-connector-status-convention/_index.md | Updates Config Connector links to newer docs.cloud.google.com URLs. |
| documentation/content/en/reference/cli/fn/eval/_index.md | Updates Docker volumes reference URL. |
| documentation/content/en/installation/migration.md | Fixes several stale GitHub/docs links referenced in migration docs. |
| documentation/content/en/book/07-effective-customizations/_index.md | Updates Jinja project URL. |
| documentation/content/en/book/05-developing-functions/_index.md | Updates Docker install URL. |
| documentation/content/en/book/04-using-functions/_index.md | Updates Docker volumes reference URL in function mount docs. |
| documentation/content/en/book/01-getting-started/_index.md | Updates Docker install URL in getting started docs. |
| documentation/content/en/_index.md | Updates “public Dosu space” link to the new dosu app URL. |
| documentation/README.md | Documents how to run external link checking locally and how to use a GitHub token. |
| documentation/Makefile | Adds check-links-external target to run lychee against built HTML. |
| README.md | Updates “public Dosu space” link to the new dosu app URL. |
| .github/workflows/docs-weekly.yml | Adds scheduled weekly workflow for docs spelling + external link checks. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
aravindtga
force-pushed
the
external-link-validation
branch
from
August 18, 2026 11:54
de7d187 to
ca4de0e
Compare
efiacor
approved these changes
Aug 28, 2026
| --- | ||
|
|
||
| `kpt` includes custom rules for [Config Connector](https://cloud.google.com/config-connector/docs/overview) resources to | ||
| `kpt` includes custom rules for [Config Connector](https://docs.cloud.google.com/config-connector/docs/overview) resources to |
Contributor
There was a problem hiding this comment.
I wonder should this page be dropped/refactored too as it's GCP specific
Contributor
Author
There was a problem hiding this comment.
Agreed. Do we need to confirm this with community before proceed to remove ?
Contributor
There was a problem hiding this comment.
Maybe we should mention it.
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.
Description
lycheefor the kpt documentation site, with a weekly CI workflow and a localmaketarget.lycheechecks all external (http/https) links in the rendered HTML. Alychee.tomlconfig handles exclusions and rate limiting. The--root-dirflag resolves root-relative paths, while theschemefilter ensures only external links are validated.Related Issue(s)
Sample run
https://github.com/aravindtga/kpt/actions/runs/32133719014
Type of Change
Checklist
AI Disclosure
If so, please describe how:
- Kiro used to implement and validate the changes.