docs: fix inaccuracies in dev docs and improve documentation guidelines - #1006
Merged
Conversation
- Also add skill to perform releases Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
ehsavoie
requested changes
Aug 3, 2026
| .authentication(new AuthenticationInfo("bearer", "my-token")) | ||
| .build(); | ||
|
|
||
| client.createTaskPushNotificationConfiguration(taskConfig); |
Collaborator
There was a problem hiding this comment.
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"); |
Collaborator
There was a problem hiding this comment.
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: |
Collaborator
There was a problem hiding this comment.
"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.
| @@ -293,7 +294,7 @@ Follow semantic versioning with qualifiers: | |||
| - **Major.Minor.Patch** - Standard releases (e.g., `1.0.0`) | |||
Collaborator
There was a problem hiding this comment.
Don't we use Final there ?
ehsavoie
approved these changes
Aug 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.