Skip to content

docs(spec): fix broken intra-document anchor links#1965

Open
msrivastav13 wants to merge 4 commits into
a2aproject:mainfrom
msrivastav13:fix/spec-broken-anchors
Open

docs(spec): fix broken intra-document anchor links#1965
msrivastav13 wants to merge 4 commits into
a2aproject:mainfrom
msrivastav13:fix/spec-broken-anchors

Conversation

@msrivastav13

Copy link
Copy Markdown
Contributor

Summary

Fixes #1945.

Three internal links in docs/specification.md pointed to anchors that no header generates, breaking in-document navigation. This corrects them to the actual section-numbered anchors:

Location Before After
Line 674 (Section 3.1.8 link) #76-taskspushnotificationconfigget #318-get-push-notification-config
Line 2573 (StreamResponse) #stream-response #323-stream-response
Line 2615 (StreamResponse) #stream-response #323-stream-response

Notes

  • Verified by checking every ](#...) link target against the set of slugs generated from the document's headers — after this change, no broken intra-document anchors remain in specification.md.
  • The reporter's specific #message example is already corrected on main; the live site still shows it because it serves the published v1.0 spec.

Three internal links in specification.md pointed to anchors that no
header generates, breaking in-document navigation:

- Section 3.1.8 (Get Push Notification Config) link pointed to
  a2aproject#76-taskspushnotificationconfigget -> a2aproject#318-get-push-notification-config
- Two StreamResponse links pointed to #stream-response ->
  a2aproject#323-stream-response

Fixes a2aproject#1945
@msrivastav13 msrivastav13 requested a review from a team as a code owner June 21, 2026 12:43

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request corrects several broken anchor links in the docs/specification.md file, ensuring they point to the correct sections (such as updating #76-taskspushnotificationconfigget to #318-get-push-notification-config and #stream-response to #323-stream-response). There are no review comments, and I have no additional feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Topic pages linked into specification.md using anchors from an older
section structure, breaking cross-page navigation:

streaming-and-async.md:
- a2aproject#61-task-object -> a2aproject#411-task
- #taskstatusupdateevent -> a2aproject#421-taskstatusupdateevent
- #taskartifactupdateevent -> a2aproject#422-taskartifactupdateevent
- a2aproject#72-messagestream -> a2aproject#312-send-streaming-message
- a2aproject#79-taskssubscribe -> a2aproject#316-subscribe-to-task
- #pushnotificationconfig -> a2aproject#431-pushnotificationconfig
- #pushnotificationpayload -> a2aproject#433-push-notification-payload
- GetTask link a2aproject#76-taskspushnotificationconfigget -> a2aproject#313-get-task

agent-discovery.md:
- a2aproject#5-agent-discovery-the-agent-card -> a2aproject#8-agent-discovery-the-agent-card

Part of a2aproject#1945

@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 :)

@msampathkumar

Copy link
Copy Markdown
Member

Let's wait for the #1966 to complete.

@msampathkumar msampathkumar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's wait for the PR #1966 to completed.

@msampathkumar msampathkumar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Hyperlinks are working in Markdown files and github redirects.

Post PR merge, please check if the site is also working fine.

Nice work @msrivastav13

@msampathkumar msampathkumar enabled auto-merge (squash) July 7, 2026 18:38
@msampathkumar

Copy link
Copy Markdown
Member

Update: since this PR updates the specs docs, TSE member need to review it.

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.

[Bug]: Invalid HTML anchors in spec

3 participants