Skip to content

docs: add multi-version documentation support#985

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

docs: add multi-version documentation support#985
kabir wants to merge 1 commit into
a2aproject:mainfrom
kabir:docs-versioned

Conversation

@kabir

@kabir kabir commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Add versioned docs with a version dropdown, per-version sidebar menus, and a version-scoped search filter. Content is organized into versioned folders (1.0.0.Final, 1.1.0.Final, dev) with the default version resolved from data files.

@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 introduces documentation versioning support for the A2A Java SDK documentation site, restructuring the content into versioned directories (such as 1.0.0.Final, 1.1.0.Final, and dev) and implementing a client-side version switcher dropdown in the sidebar. The review feedback focuses on improving the robustness of this implementation, including: comparing resolved URL pathnames instead of raw href attributes to prevent search filtering failures with absolute URLs; updating the version switcher to correctly handle sub-pages; wrapping relative links in site.url() to ensure correct resolution; and using the existing CSS variable var(--color-accent-800) instead of a hardcoded color value in the stylesheet.

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/src/main/resources/templates/partials/roq-default/head-scripts.html Outdated
Comment thread docs/src/main/resources/templates/partials/roq-default/head-scripts.html Outdated
Comment thread docs/content/index.html Outdated
Comment thread docs/content/index.html Outdated
Comment thread docs/web/_custom.css Outdated
@kabir
kabir force-pushed the docs-versioned branch 2 times, most recently from 4b1bb04 to d95380b Compare July 21, 2026 10:21
@kabir

kabir commented Jul 21, 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 introduces a versioned documentation system for the A2A Java SDK website, restructuring content into version-specific directories and implementing a client-side version switcher. Feedback on these changes focuses on improving robustness and URL handling, specifically by adding null and blank validations in the Versions and MenuItem constructors, and ensuring basePath ends with a trailing slash in the JavaScript switcher to prevent broken links.

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/src/main/java/org/a2aproject/docs/Versions.java
Comment thread docs/src/main/java/org/a2aproject/docs/Versions.java
Add versioned docs with a version dropdown, per-version sidebar menus,
and a version-scoped search filter. Content is organized into versioned
folders (1.0.0.Final, 1.1.0.Final, dev) with the default version
resolved from data files.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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