Skip to content

Link fixes#1950

Open
kristin-kronstain-brown wants to merge 2 commits into
mainfrom
kkb-links-6-1-26
Open

Link fixes#1950
kristin-kronstain-brown wants to merge 2 commits into
mainfrom
kkb-links-6-1-26

Conversation

@kristin-kronstain-brown
Copy link
Copy Markdown

@kristin-kronstain-brown kristin-kronstain-brown commented Jun 1, 2026

fix: update stale and broken URLs in Go API type comments

Three sets of comment URLs in the API type definitions were either redirecting or pointing to renamed anchors, causing failures in downstream docs link checking.

Changes

  • github.com/google/A2Agithub.com/a2aproject/A2A (v1alpha1 and v1alpha2 agent_types.go): The A2A project moved to a new GitHub org. Updated the link in the a2aConfig field description.

  • #cross-namespace-routing#cross-namespace-route-attachment (agent_types.go, remotemcpserver_types.go, common_types.go): The Gateway API docs renamed this anchor. The old fragment no longer exists on the guides/multiple-ns/ page.

  • adk-python/issues/3921) (agent_types.go): Added a space before the closing parenthesis so URL parsers don't include it as part of the link.

These comments flow into the auto-generated API reference docs via crd-ref-docs, so fixing them here eliminates the link checker warnings in downstream doc sites.

Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates several outdated documentation links in API type comments to their current canonical locations.

Changes:

  • Updates Gateway API multi-namespace docs anchor from #cross-namespace-routing to #cross-namespace-route-attachment in three files.
  • Updates the A2A protocol repository link from github.com/google/A2A to github.com/a2aproject/A2A in v1alpha1 and v1alpha2 agent types.
  • Adds a trailing space inside the adk-python issue link comment.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
go/api/v1alpha2/remotemcpserver_types.go Fix Gateway API anchor link in AllowedNamespaces doc comment.
go/api/v1alpha2/common_types.go Fix Gateway API anchor link in FromNamespaces doc comment.
go/api/v1alpha2/agent_types.go Fix Gateway API anchor and A2A repo link; minor edit to adk-python link comment.
go/api/v1alpha1/agent_types.go Update A2A repo link in A2AConfig doc comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread go/api/v1alpha2/agent_types.go
@peterj
Copy link
Copy Markdown
Collaborator

peterj commented Jun 1, 2026

thanks for the PR! Can you also make sure you run make controller-manifests and include the files that get generated?

Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants