| name | fix-broken-links |
| description | Review a Lychee link checker report from a GitHub issue and propose fixes for errors, warnings (broken anchors), and redirects in a Hugo docs repo. Use when the user asks to "fix broken links", "review the link report", "triage link checker issues", or points at a link checker issue (for example agentgateway/website#383). |
| version | 1.0.0 |
Fix broken links skill
Use this skill when the user provides a Lychee link checker report (usually posted as a GitHub issue) and asks to triage or fix the findings in a Hugo-based documentation repository.
The report has three sections: Errors, Warnings (broken anchors), and Redirects. Each bullet contains the link, followed by Found on: with one or more source HTML paths under public/.
Input
The user will give you a link to a GitHub issue, or paste the issue body. Example: https://github.com/agentgateway/website/issues/383
If given a URL, fetch the issue body with:
gh issue view <N> --repo <owner>/<repo> --json body -q .body
Mapping source paths to editable files
Source paths in the report look like public/docs/kubernetes/latest/install/argocd/index.html. These are built HTML files โ you cannot edit them directly. Map them to source files:
- Thin content wrapper: Under
content/ (the Hugo content directory). Often a .md file whose body is just {{< reuse "..." >}} or a similar include.
- Asset / reuse body: If the content wrapper is a reuse or include, the real prose lives under a shared directory (in this repo,
assets/agw-docs/pages/...). Edit the shared file, not the thin wrapper. Editing the shared file fixes all versions that reuse it.
- Snippet: A smaller shared fragment (in this repo, under
assets/agw-docs/snippets/...) if referenced through another reuse chain.
How to tell which category a page falls in:
- Read the content file at the mapped path.
- If the body is essentially one
{{< reuse "..." >}} shortcode (or similar include), follow that reference to the shared file and edit there.
- If the body has real prose, edit the content file directly.
Example mapping:
public/docs/kubernetes/latest/install/argocd/index.html
โ content wrapper: content/docs/kubernetes/latest/install/argocd.md
โ if wrapper is {{< reuse "agw-docs/pages/install/argocd.md" >}}, edit assets/agw-docs/pages/install/argocd.md
Scope โ Content updated via automation
- Reference docs: Any source path under a
reference/ directory (for example public/docs/kubernetes/*/reference/api/index.html, reference/helm/*, reference/cel/*) is generated from upstream code repos. Do not hand-edit the generated markdown files in this docs repo. Instead, trace the broken link to its upstream source (Go comments, Helm chart values, or crd-ref-docs config) and fix it there. Use the mapping below to identify the right upstream file. Report both the upstream fix location and a note that the generated file in this repo will update on the next regeneration.
- Other generated content: Apply the same rule for any other directory the repo treats as build output of external sources. Check the repo's README or CONTRIBUTING guide if unsure.
Auto-generated content sources โ tracing broken links upstream
When a broken link appears on a reference/ page, use this map to trace it to the upstream source that needs fixing. The agentgateway workflow that produces these is reference-docs.yaml.
Generation pipeline
The workflow reads version entries from hugo.yaml (params.sections.standalone.versions and params.sections.kubernetes.versions). Each entry has a version (e.g. 1.1.x), a linkVersion (e.g. latest), and a url. The linkVersion determines the generated filename (api-{linkVersion}.md) and the git ref used:
linkVersion: "main" โ checks out the main branch of agentgateway/agentgateway- Any other
linkVersion โ resolves the latest git tag matching v{version-prefix}* (e.g. 1.1.x โ latest v1.1.* tag)
The generator is github.com/elastic/crd-ref-docs configured by scripts/crd-ref-docs-config.yaml. That config controls kubernetesVersion (for k8s type links) and knownTypes (for overriding type links like PullPolicy, Duration).
Generated file โ upstream source mapping
| Generated file (in this repo) | Upstream source repo | Upstream source path | Generator |
|---|
assets/agw-docs/pages/reference/api/api-{linkVersion}.md (API CRD reference) | agentgateway/agentgateway | controller/api/v1alpha1/agentgateway/ | crd-ref-docs + scripts/crd-ref-docs-config.yaml |
assets/agw-docs/pages/reference/api/api-{linkVersion}.md (shared types appended, includes CEL) | agentgateway/agentgateway | controller/api/v1alpha1/shared/ | scripts/generate-shared-types.py |
assets/agw-docs/pages/reference/helm/{linkVersion}/agentgateway.md and agentgateway-crds.md | agentgateway/agentgateway | install/helm/agentgateway/ and install/helm/agentgateway-crds/ | helm-docs via scripts/generate-ref-docs.py |
assets/agw-docs/snippets/metrics-control-plane-{linkVersion}.md | agentgateway/agentgateway | control plane metrics output | scripts/generate-ref-docs.py |
Generated file โ content wrapper โ published URL mapping
This shows which content page includes each generated reference file, and the published URL it appears at:
| Content wrapper | Reuses generated file | Published URL |
|---|
content/docs/kubernetes/main/reference/api.md | api-main.md | /docs/kubernetes/main/reference/api/ |
content/docs/kubernetes/latest/reference/api.md | api-main.md | /docs/kubernetes/latest/reference/api/ |
content/docs/kubernetes/1.0.x/reference/api.md | api-latest.md | /docs/kubernetes/1.0.x/reference/api/ |
content/docs/kubernetes/2.2.x/reference/api.md | api-22x.md | /docs/kubernetes/2.2.x/reference/api/ |
content/docs/kubernetes/main/reference/helm/agentgateway.md | helm/main/agentgateway.md | /docs/kubernetes/main/reference/helm/agentgateway/ |
content/docs/kubernetes/latest/reference/helm/agentgateway.md | helm/main/agentgateway.md | /docs/kubernetes/latest/reference/helm/agentgateway/ |
content/docs/kubernetes/1.0.x/reference/helm/agentgateway.md | helm/latest/agentgateway.md | /docs/kubernetes/1.0.x/reference/helm/agentgateway/ |
content/docs/kubernetes/2.2.x/reference/helm/agentgateway.md | helm/2.2.x/agentgateway.md | /docs/kubernetes/2.2.x/reference/helm/agentgateway/ |
Key implication: Older doc versions (like 1.0.x) use api-latest.md / helm/latest/, which are generated from the latest release tag of agentgateway/agentgateway. These files are only regenerated when the workflow runs โ fixes merged to the upstream main branch won't appear in api-latest.md until a new tag is cut or the workflow is manually re-run for that version.
How to fix broken links in reference content
When you find a broken link on a reference page, trace it upstream and fix it at the source:
-
URLs in Go doc comments (API CRD reference): The broken URL is in a Go struct field comment in agentgateway/agentgateway under controller/api/v1alpha1/. Fix the comment in the Go source. If the user has a local clone/fork (e.g. at agentgateway.dev-fork), make the fix there.
-
URLs in Helm chart values (Helm reference): The broken URL is in a values.yaml description in agentgateway/agentgateway under install/helm/. Fix the description in the Helm chart source.
-
Type links generated by crd-ref-docs (e.g. broken #pullpolicy-v1-core or #duration-v1-meta anchors on kubernetes.io): These aren't in Go source โ they're generated by the crd-ref-docs tool based on Go type references. Fix by adding knownTypes entries in scripts/crd-ref-docs-config.yaml in this repo to override the generated URLs.
-
Boilerplate k8s descriptions (e.g. git.k8s.io/community/.../api-conventions.md#types-kinds): These come from upstream Kubernetes API machinery type definitions that crd-ref-docs injects. They cannot be fixed in Go source or config โ note them as unfixable upstream boilerplate.
Enterprise repo (solo-io/agentgateway-enterprise) โ OSS vs enterprise-owned files
The enterprise repo syncs OSS code from agentgateway/agentgateway via a Sync Upstream OSS workflow. A Protect Upstream workflow enforces that synced paths can only be changed through sync/ branches, not direct PRs. This means:
-
OSS-synced (fix in agentgateway/agentgateway, not in the enterprise repo):
controller/ โ entire directory, including controller/api/v1alpha1/agentgateway/ and controller/api/v1alpha1/shared/. These are copies of the OSS CRD types. Fixes to Go doc comments here must be made in the OSS repo first, then synced.go.mod, go.sum
-
Enterprise-owned (fix directly in the enterprise repo):
ent-controller/ โ enterprise-specific code, including ent-controller/api/v1alpha1/enterpriseagentgateway/ (the EnterpriseAgentgateway* CRD types) and ent-controller/api/v1alpha1/shared/- Everything outside
controller/ that isn't in the exclude list
The exclude list (.github/enterprise.exclude-defaults.txt) defines paths that are expected to diverge and are skipped during drift reports: ent-controller/**, .gitignore, Cargo.lock, *.pb.go, *.gen.go, schema/**, and dependency files.
Rule of thumb: If the broken link traces to a file under controller/ in the enterprise repo, fix it in agentgateway/agentgateway instead. If it traces to ent-controller/, fix it directly in the enterprise repo.
After fixing upstream, the generated files in this repo will update on the next workflow run. For older versions pinned to release tags, either re-run the workflow manually or accept that the fix only applies going forward.
When reporting, include the upstream file path and line number so the user knows exactly where to apply the fix or open a PR.
Triage workflow
Work through the report top-down: Errors first, then Warnings, then Redirects. For each entry:
- Skip if the source is under
reference/ or another generated directory (see above).
- Identify the source file(s) to edit using the mapping above.
- Apply the rules for that category below.
- Record the finding in a summary you'll report to the user at the end.
Do NOT open a PR or push commits. Make local edits only. The user will review.
Errors
Broken links (non-anchor, or anchors where the page itself is gone).
- Check for false positives first. Fetch the URL (WebFetch) to see if it actually loads. If it does, note it as a false positive and suggest a likely reason:
- JS-rendered anchors (common for kubernetes.io tabs, AWS console, Azure Learn, Google AI docs, and other modern docs sites). Lychee parses static HTML and looks for
id="...". Pages that build anchors with JavaScript at runtime have no matching IDs in the static HTML, so lychee reports them broken even though they work in browsers. There is no lychee config to fix this short of running JS. To verify: curl the page, grep for id= near the expected anchor name. If the page's static HTML has no IDs that match the expected pattern and the page loads in a browser to the right section, it's JS-rendered. Important: a missing static id= could also mean the anchor is genuinely broken (the section was renamed) โ always confirm in a browser before calling it a false positive.
- Lychee user-agent blocked or rate limiting.
- URL-encoding Lychee mishandles (for example trailing
%29 from a stray ) in markdown).
- Link is inside a tab / collapsible / conditional-render that Lychee parses differently.
- Try to find the new location. Read the source file and look at the text surrounding the link. If the link is clearly meant to point somewhere specific (for example, a markdown link like
[install guide](URL)), check whether the target content moved. Browse the target site (WebFetch the parent directory listing or use a site search) to locate the current URL.
- Apply the fix in the mapped source file (shared/asset file if the content wrapper is a reuse, otherwise the content file). If you cannot confidently determine the new URL, record it as "needs human review" and do not edit.
Warnings โ broken anchors
The page exists but the #fragment does not resolve.
- Fetch the target page and check the current anchor IDs (search for
id="..." in the HTML).
- Map the old anchor to the current one โ sections are often renamed (for example
#health-checks โ #health-check-policies).
- If the anchor's content moved to a different page, update both the path and the fragment.
- If the content was removed entirely, consider removing the link or changing it to a page-level link. Flag this for review.
- For warnings on external sites (kubernetes.io, git.k8s.io, gateway-api.sigs.k8s.io, etc.) that look like false positives, verify in-browser โ these often work but Lychee's fragment validator can be strict about URL-encoded anchors. Leave a note rather than silently excluding.
Redirects
Lychee reports each as original โ final.
- Skip auth/login redirects. If
final is a sign-in / SSO / login page, the original URL is fine โ users will authenticate and reach the right place. Don't edit. Report it back though.
- Skip canonical short-form / always-redirecting URLs. Some URLs are intentionally short forms that always redirect to the current target. Don't update these โ instead, suggest adding them to
lychee.toml's exclude list so they stop appearing in future reports. Examples:
github.com/<owner>/<repo>/releases/latest โ versioned tag (the /latest URL is intentional โ it auto-tracks the newest release).discord.gg/<code> โ discord.com/invite/<code> (the short form is canonical).github.com/user-attachments/assets/<id> โ time-limited S3 signed URL (the short form is the only stable URL).
- Otherwise, update the source to the
final URL. Common cases are vendor doc restructures (Microsoft Learn, Google Cloud, Anthropic, AWS) and project rebrands or host moves.
Making edits
- Edit shared/asset files when the content wrapper is a reuse or include. This fixes all versions at once.
- Edit content files only when the content is version-specific and not a reuse.
- If the same broken link appears in multiple source files that all trace back to the same shared file, edit the shared file once.
- Use the
Edit tool with enough surrounding context to make the match unique.
- For repeated identical replacements across many files (typical for redirect fixes), batch with
sed -i '' over a find of the relevant directories. Always quote URLs and escape . and / carefully. After a batch, grep to confirm the old pattern is gone.
- Watch for trailing-slash variants. A URL like
https://jwt.io/ appears in the report, but docs often also contain https://jwt.io (no slash) in other files. A sed pattern of jwt\.io/ won't match the no-slash form. Either run two sed passes (with and without the trailing slash), or use a pattern that tolerates both (for example, matching inside markdown link parentheses: (https://jwt\.io) and (https://jwt\.io/)). After the batch, grep for the base hostname (without slash) to catch any stragglers.
Conditional content for cross-variant link breakage
If a link works for one product variant (for example, the Kubernetes docs) but the target doesn't exist in another variant (for example, the standalone docs) because the content is organized differently, wrap the offending sentence in a build-condition shortcode rather than removing it. Check the repo for an existing conditional-text shortcode and use it like:
{{< conditional-text include-if="kubernetes" >}}For more information, see [...](...).{{< /conditional-text >}}
This keeps the link visible where it works and silently drops it where it doesn't.
Updating lychee config for false positives
When you confirm a class of false positives, update the shared lychee.toml exclude list so they don't reappear. Group the patterns with a comment explaining why (JS-rendered anchors, intentional short-form URLs, etc.) so future maintainers don't strip them as noise.
Reporting back
After processing the report, give the user a structured summary. Group findings by outcome:
## False positives
- <link> โ <why it's actually working> (added to lychee.toml exclude / suggest adding to lychee.toml exclude)
## Skipped โ kept as redirect-as-intended
- <link> โ <why the redirect is intentional> (added to lychee.toml exclude / suggest adding)
## Needs human review
- <link> in <file> โ <why: couldn't determine new URL / content removed / cross-variant content gap / shortcode bug / etc.>
## Generated reference content โ upstream fixes needed
- <link> โ fix in <upstream file:line> (<Go comment / Helm values / crd-ref-docs config / unfixable k8s boilerplate>)
Keep the summary concise. Do not include long lists of identical reference/ skips. Fixed links do not need to be reported individually unless the user specifically asks. If you spot a root-cause bug (for example a shortcode that produces broken URLs for certain inputs), call it out in "Needs human review" with a pointer to the file and the suggested fix.
Don't
- Don't open a PR or push. Local edits only.
- Don't edit files under
public/ โ those are build output.
- Don't hand-edit generated reference markdown in this repo โ fix upstream in the Go source, Helm chart, or
crd-ref-docs-config.yaml instead.
- Don't guess new URLs. If you can't verify, flag for review.
- Don't edit the thin content wrapper when the body is a reuse โ edit the shared file.
