Skip to content

docs(site): extract standalone pages and complete doc structure#977

Open
kabir wants to merge 2 commits into
a2aproject:mainfrom
kabir:docs-site-pr
Open

docs(site): extract standalone pages and complete doc structure#977
kabir wants to merge 2 commits into
a2aproject:mainfrom
kabir:docs-site-pr

Conversation

@kabir

@kabir kabir commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Extract configuration, authorization, and backward compatibility into
standalone pages. Add REST API reference, BOMs, examples, and getting
started pages. Update navigation menu and add compatibility matrix to
landing page.

Overrides the default Roq page layout to use `link: /:raw-path`,
which prevents URL slugification of directory names (e.g., keeps
`1.0.0.Final` instead of `1-0-0-final`). Required for the versioned
documentation site restructure described in the plan at
docs/superpowers/plans/2026-06-25-versioned-doc-site-plan.md.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@kabir kabir requested a review from jmesnil July 9, 2026 15:23

@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 reorganizes and expands the documentation for the A2A Java SDK. It splits the monolithic server guide into dedicated pages for task authorization, configuration, and backward compatibility, while adding new sections for getting started, BOMs, examples, and a REST API reference. The review feedback highlights several issues in the newly added documentation, including a mismatch in the Java version prerequisite (Java 11 vs. Java 17), a mix of CDI and Spring annotations in a configuration provider example, a minor phrasing inconsistency regarding leading slashes in the REST API reference, and potential null pointer exceptions in the task authorization code snippets.

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 docs/content/examples.md Outdated
Comment thread docs/content/configuration.md
Comment thread docs/content/rest-api-reference.md Outdated
Comment thread docs/content/authorization.md
Comment thread docs/content/authorization.md
Extract configuration, authorization, and backward compatibility into
standalone pages. Add REST API reference, BOMs, examples, and getting
started pages. Update navigation menu and add compatibility matrix to
landing page.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@kabir

kabir commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator Author

/gemini review

@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 restructures and significantly expands the documentation for the A2A Java SDK by breaking down the monolithic server and client guides into dedicated, modular pages (Getting Started, Configuration, Task Authorization, Backward Compatibility, BOMs, Examples, and REST API Reference). It also updates the navigation menu, adds a compatibility table to the homepage, and adjusts CSS styles. The review feedback points out a few inconsistent repository URLs in the examples documentation that still reference the old organization name, and suggests optimizing a CSS transition max-height to ensure smooth menu animations.

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 docs/content/examples.md

### Run the Python Client

The Python client is part of the [a2a-samples](https://github.com/google-a2a/a2a-samples) project:

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.

medium

The repository URL uses the google-a2a organization, but the project is hosted under the a2aproject organization (as seen on line 149 of this file and in menu.yml). Updating this ensures consistency and avoids potential broken links or redirects.

Suggested change
The Python client is part of the [a2a-samples](https://github.com/google-a2a/a2a-samples) project:
The Python client is part of the [a2a-samples](https://github.com/a2aproject/a2a-samples) project:

Comment thread docs/content/examples.md
The Python client is part of the [a2a-samples](https://github.com/google-a2a/a2a-samples) project:

```bash
git clone https://github.com/google-a2a/a2a-samples.git

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.

medium

Update the clone URL to use the correct a2aproject organization name for consistency.

Suggested change
git clone https://github.com/google-a2a/a2a-samples.git
git clone https://github.com/a2aproject/a2a-samples.git

Comment thread docs/content/examples.md
### Start the Python Server

```bash
git clone https://github.com/google-a2a/a2a-samples.git

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.

medium

Update the clone URL to use the correct a2aproject organization name for consistency.

Suggested change
git clone https://github.com/google-a2a/a2a-samples.git
git clone https://github.com/a2aproject/a2a-samples.git

Comment thread docs/web/_custom.css
.menu-group-children-wrapper {
overflow: hidden;
max-height: 300px;
max-height: 2000px;

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.

medium

Using a very large max-height (like 2000px) for CSS transitions on elements with much smaller actual height (e.g., a few hundred pixels for the menu) causes a noticeable delay when collapsing the menu, and makes the expansion animation feel instantaneous. Consider using a more reasonable limit like 1000px which is still plenty of room for the menu items but keeps the transition smooth and responsive.

Suggested change
max-height: 2000px;
max-height: 1000px;

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.

1 participant