Skip to content

docs: Updating README to point to the website for documentation thus#961

Merged
kabir merged 1 commit into
a2aproject:mainfrom
ehsavoie:update_readme
Jul 1, 2026
Merged

docs: Updating README to point to the website for documentation thus#961
kabir merged 1 commit into
a2aproject:mainfrom
ehsavoie:update_readme

Conversation

@ehsavoie

Copy link
Copy Markdown
Collaborator

avoiding duplication

@ehsavoie ehsavoie requested review from jmesnil and kabir June 30, 2026 07:54

@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 significantly simplifies the README.md file by removing detailed setup, configuration, and usage instructions, replacing them with links to the official external documentation. The reviewer identified an incorrect URL path for the announcements link and provided a suggestion to correct it.

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.

Comment thread README.md

@kabir kabir left a comment

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.

Is this a bit premature?

We need the 'completed' new site first, and a lot of the info it needs will come from here

@ehsavoie

Copy link
Copy Markdown
Collaborator Author

@kabir I disagree, the website already provides all the details. We shouldn't duplicate those on the README

@ehsavoie ehsavoie changed the title docs: Updating README to point to the website for docuementation thus docs: Updating README to point to the website for documentation thus Jun 30, 2026
@ehsavoie

ehsavoie commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator Author

@kabir the code examples have been moved to the server.md and client.md

Replace ~870 lines of detailed setup, configuration, and API usage
documentation in README.md with a slim overview linking to
a2aproject.github.io/a2a-java. Migrate the removed content into
docs/content/server.md (configuration system, task authorization,
user identity, v0.3 backward compatibility) and docs/content/client.md
(push notification config, REST transport, v0.3 client notes).

Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
@kabir kabir merged commit 7aa5c01 into a2aproject:main Jul 1, 2026
12 checks passed
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