Skip to content

Commit 609c2cd

Browse files
kabirclaude
andcommitted
docs: add multi-version documentation support
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>
1 parent 9bb5aa5 commit 609c2cd

54 files changed

Lines changed: 4295 additions & 135 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,10 @@ mvn clean install
7474
- Try to use existing code instead of generating new similar code
7575
- Use the same code convention than existing code. If the existing convention seems incorrect, make suggestion before doing any changes
7676

77+
### Documentation Site
78+
79+
The docs site (`docs/`) uses versioned content folders (`docs/content/1.0.0.Final/`, `docs/content/1.1.0.Final/`, `docs/content/dev/`). When updating documentation to reflect code changes, only edit pages under `docs/content/dev/` — released version folders are frozen snapshots and must not be modified. New versioned folders are created at release time (see RELEASE.md).
80+
7781
### PR instructions
7882
- Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) for the commit title and message
7983
- Always ask if the commit is related to a GitHub issue. If that's the case, add a `This fixes #{issue_number}` at the end of the commit message

RELEASE.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,32 @@ Artifacts should include:
161161
- `.pom` files
162162
- `.asc` GPG signatures for all artifacts
163163

164-
### 9. Increment to Next SNAPSHOT
164+
### 9. Update Versioned Documentation
165+
166+
Create a new documentation version for the release:
167+
168+
```bash
169+
# Copy dev docs to the new version folder
170+
cp -r docs/content/dev docs/content/X.Y.Z.Final
171+
172+
# Create a new version data file
173+
cp docs/data/versions/dev.yml docs/data/versions/X.Y.Z.Final.yml
174+
```
175+
176+
Edit `docs/data/versions/X.Y.Z.Final.yml`:
177+
- Set `label` to `"X.Y.Z.Final"`
178+
- Set `path` to `"X.Y.Z.Final"`
179+
- Set `sortOrder` to the next number (higher than the previous release)
180+
- Set `defaultVersion` to `true`
181+
- Set `devVersion` to `false`
182+
- Adjust the `menu` list if the new version adds or removes pages
183+
184+
Update the previous default version's data file (e.g., `docs/data/versions/OLD_VERSION.yml`):
185+
- Set `defaultVersion` to `false`
186+
187+
Review the new version's content for accuracy — ensure all pages reflect features available in this release.
188+
189+
### 10. Increment to Next SNAPSHOT
165190

166191
Prepare repository for next development cycle:
167192

boms/extras/src/it/extras-usage-test/src/main/java/org/a2aproject/sdk/bom/test/extras/ExtrasBomVerifier.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ public class ExtrasBomVerifier extends DynamicBomVerifier {
1313

1414
private static final Set<String> EXTRAS_EXCLUSIONS = Set.of(
1515
"boms/", // BOM test modules themselves
16+
"docs/", // Documentation site (not an SDK artifact)
1617
"examples/", // Example applications
1718
"itk/", // Integration Test Kit agent
1819
"tck/", // TCK test suite

boms/reference/src/it/reference-usage-test/src/main/java/org/a2aproject/sdk/bom/test/reference/ReferenceBomVerifier.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ public class ReferenceBomVerifier extends DynamicBomVerifier {
1313

1414
private static final Set<String> REFERENCE_EXCLUSIONS = Set.of(
1515
"boms/", // BOM test modules themselves
16+
"docs/", // Documentation site (not an SDK artifact)
1617
"examples/", // Example applications
1718
"itk/", // Integration Test Kit agent
1819
"tck/", // TCK test suite

boms/sdk/src/it/sdk-usage-test/src/main/java/org/a2aproject/sdk/bom/test/sdk/SdkBomVerifier.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ public class SdkBomVerifier extends DynamicBomVerifier {
1313

1414
private static final Set<String> SDK_EXCLUSIONS = Set.of(
1515
"boms/", // BOM test modules themselves
16+
"docs/", // Documentation site (not an SDK artifact)
1617
"examples/", // Example applications
1718
"itk/", // Integration Test Kit agent
1819
"tck/", // TCK test suite
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ Client client = Client
190190

191191
## Communicating with v0.3 Agents
192192

193-
See [Backward Compatibility]({site.url('compatibility')}#client-communicating-with-v03-agents) for using `Client_v0_3` with older protocol agents.
193+
See [Backward Compatibility](compatibility#client-communicating-with-v03-agents) for using `Client_v0_3` with older protocol agents.
194194

195195
## Examples
196196

197-
See [Examples]({site.url('examples')}) for Hello World walkthroughs and sample applications.
197+
See [Examples](examples) for Hello World walkthroughs and sample applications.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ mvn exec:java -Dopentelemetry=true
142142

143143
The client expects an OpenTelemetry collector on port 5317. The easiest way is to run the Java server with `-Popentelemetry` (which starts the collector automatically), then run the client with `-Dopentelemetry=true` for end-to-end traces.
144144

145-
For more information, see the [OpenTelemetry extras module]({site.url('/extras/opentelemetry')}).
145+
For more information, see the [OpenTelemetry extras module](extras/opentelemetry).
146146

147147
## More Examples
148148

0 commit comments

Comments
 (0)