Skip to content

docs: fix inaccuracies in dev docs and improve documentation guidelines - #1006

Open
kabir wants to merge 1 commit into
a2aproject:mainfrom
kabir:docs-revision
Open

docs: fix inaccuracies in dev docs and improve documentation guidelines#1006
kabir wants to merge 1 commit into
a2aproject:mainfrom
kabir:docs-revision

Conversation

@kabir

@kabir kabir commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator
  • Also add skill to perform releases

- Also add skill to perform releases

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
.authentication(new AuthenticationInfo("bearer", "my-token"))
.build();

client.createTaskPushNotificationConfiguration(taskConfig);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maybe show the returned value

```java
AgentCard card = A2ACardResolver.builder().baseUrl("http://localhost:1234")
.build().getAgentCard();
AgentCard_v0_3 agentCard = A2A_v0_3.getAgentCard("http://localhost:1234");

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maybe add a comment that says that 0.3 version makes this methid handle discovery

- `A2AError` — error events

Events are serialized using Jackson with polymorphic type information:
Events are serialized using Gson with member-name wrapping to preserve type information:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

"member-name wrapping" is Gson-specific jargon. A brief explanation of what it means (the event type name becomes the JSON key wrapping the event data) would help implementers understand the format change.

Comment thread RELEASE.md
@@ -293,7 +294,7 @@ Follow semantic versioning with qualifiers:
- **Major.Minor.Patch** - Standard releases (e.g., `1.0.0`)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Don't we use Final there ?

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.

2 participants