[Feat]: Create a page on the A2A website to view the javadoc for a2a-java and link to it from the project README

[AlexElin]

Is your feature request related to a problem? Please describe.

At the moment the javadoc of the library is not available.

Describe the solution you'd like

Publish the javadoc and provide link to it in the README.md

Describe alternatives you've considered

No response

Additional context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[spandey1702]

Hi @fjuma , @AlexElin

I'd like to work on this issue. Could you please assign it to me?

I have experience with Java and Maven builds, and I've worked with similar dependency management issues in previous projects. I can help update the Maven dependencies to their latest versions and test for any compatibility issues.

Thank you!

[kabir]

Hi @spandey1702 @AlexElin ,

We have the ability to generate JavaDoc. It is in the release profile of the root pom.xml (it is needed to be able to release to Maven Central).

But it looks like you might be talking about something slightly different from that. What we do is simply generate the javadoc per jar.

[fjuma]

The Python SDK publishes their API docs here:

https://a2a-protocol.org/latest/sdk/python/api/

Looks like the source for that is part of the A2A project:
https://github.com/a2aproject/A2A/tree/main/docs/sdk/python

So this issue will involve adding something similar to the https://github.com/a2aproject/A2A/tree/main/docs/sdk directory to be able to view our JavaDoc. Once that's done, we can update our README to link to it.

[AlexElin]

Hi @kabir, I've meant that the javadoc should be published somewhere.

Good example is https://github.com/ben-manes/caffeine . They publish the javadoc and provide a link to them in the README

[fjuma]

This issue depends on #377