Skip to content

docs(spec): fix link-checker findings and re-enable partners.md checking (#2100) - #2114

Open
msampathkumar wants to merge 10 commits into
a2aproject:mainfrom
msampathkumar:fix/link-checker-2100
Open

docs(spec): fix link-checker findings and re-enable partners.md checking (#2100)#2114
msampathkumar wants to merge 10 commits into
a2aproject:mainfrom
msampathkumar:fix/link-checker-2100

Conversation

@msampathkumar

@msampathkumar msampathkumar commented Aug 5, 2026

Copy link
Copy Markdown
Member

Summary

Closes #2100. Follows up on #2106, which had excluded docs/partners.md from link checking to silence the failures. Rather than keep partners skipped, this re-enables checking so future dead links are caught.

Changes

Relocated / renamed targets → canonical URLs

  • ADK docs google.github.io/adk-docs/*adk.dev/* (community.md, index.md, topics/what-is-a2a.md)
  • Hector repo transferred kadirpekel/hectorverikod/hector
  • Swift client renamed tolgaki/a2a-client-swifttolgaki/a2a-swift-client (link + badge)
  • Microsoft Agent Framework page → agent-framework/integrations/a2a

Redirect canonicalization (checked docs)

  • IETF RFCs tools.ietf.org/html/*datatracker.ietf.org/doc/html/* (RFC 2119/7515/8785/9111)
  • ProtoJSON guide → trailing-slash canonical
  • DeepLearning.AI → www.deeplearning.ai

Re-enable partners.md link checking (reverses the exclusion from #2106)

  • Removed the docs/partners.md and built-site/partners exclusions from lychee.toml.
  • Upgraded 18 insecure http:// partner links to https:// (scheme only — no domain/brand changes).
  • Narrowly excluded only the Crubyt URL (expired SSL cert, no working variant) instead of the whole partners page.

Spelling allowlist

  • Added datatracker and verikod to .github/actions/spelling/allow.txt (new tokens from the link fixes).

Deliberately NOT changed

  • Partner redirects that cross a company boundary (e.g. acquisitions) or add marketing params — editorial calls, not link fixes, and lychee.toml already accepts 301/302/307/308/403.
  • raw.githubusercontent.com redirects — generated by the mkdocs-material content.action.view feature, not present in source (being removed in a separate PR).

Verification

Ran lychee v0.22.0 locally with the repo config against all changed docs:

🔍 335 Total  ✅ 263 OK  🚫 0 Errors  👻 30 Excluded  🔀 42 Redirects

Fixes #2100

Point moved/renamed targets at their canonical URLs:
- ADK docs google.github.io/adk-docs/* -> adk.dev/*
- Hector repo kadirpekel/hector -> verikod/hector
- Swift client tolgaki/a2a-client-swift -> a2a-swift-client
- MS Agent Framework -> agent-framework/integrations/a2a
…ect#2100)

Point links at their final canonical URLs to avoid redirects:
- IETF RFCs tools.ietf.org/html/* -> datatracker.ietf.org/doc/html/*
- RFC 9111 -> datatracker (rfc-editor /info still 302s)
- ProtoJSON guide -> trailing-slash canonical
- DeepLearning.AI -> www.deeplearning.ai

Skipped (intentional): partners.md (excluded in lychee.toml), mkdocs
template-generated raw.githubusercontent links, and version-pinned
redirect targets (MCP root, CrewAI).
Stop skipping partners.md (broad exclusion added in a2aproject#2106) so future
dead links are caught. Instead:
- Upgrade 18 insecure http:// partner links to https:// (scheme only;
  no domain/brand changes).
- Narrowly exclude only the Crubyt URL (expired SSL cert, no working
  variant) instead of the whole partners page.

Verified locally with lychee v0.22.0 + this config: 0 errors on all
changed docs (redirects/403s are accepted per lychee.toml).

Refs a2aproject#2106
@msampathkumar
msampathkumar requested review from a team as code owners August 5, 2026 19:10
…roject#2100)

New tokens introduced by the link fixes:
- verikod: Hector repo's new owner (community.md)
- datatracker: IETF canonical RFC host (specification.md, governance)
@msampathkumar msampathkumar changed the title docs: fix link-checker findings and re-enable partners.md checking (#2100) docs(spec): fix link-checker findings and re-enable partners.md checking (#2100) Aug 5, 2026

@keraron keraron left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Link Checker Report

2 participants