Skip to content

Commit ccb9590

Browse files
rinceyuanZhangyi Yuan
andauthored
docs(java): fix the installation section structure (#2521)
Two sentences told the reader to replace `${copilot.sdk.version}`, but no snippet contains that placeholder - the release automation writes concrete versions in. The copy under the snapshot Gradle example additionally said to use "the latest release from Maven Central" while showing a -SNAPSHOT. `Snapshot Builds` was also nested under `### Gradle` even though it covers both build tools, and the snapshot Gradle example sat at `###`, so the page rendered two sibling "Gradle" installation sections with conflicting versions (and a duplicate `gradle` heading slug). Promote the section to `### Snapshot builds` with `#### Maven` / `#### Gradle` underneath, and drop the stale sentences. No version string changes, so scripts/update-documentation-versions.sh keeps its one-release-and-one-snapshot contract for both build tools. Co-authored-by: Zhangyi Yuan <j-zhangyiyuan@microsoft.com>
1 parent 495f90a commit ccb9590

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

java/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ runtime.
3030

3131
### Maven
3232

33-
Replace `${copilot.sdk.version}` with the latest release from Maven Central.
34-
3533
```xml
3634
<dependency>
3735
<groupId>com.github</groupId>
@@ -46,9 +44,11 @@ Replace `${copilot.sdk.version}` with the latest release from Maven Central.
4644
implementation 'com.github:copilot-sdk-java:1.0.13-preview.5'
4745
```
4846

49-
#### Snapshot Builds
47+
### Snapshot builds
48+
49+
Snapshot builds of the next development version are published to Maven Central Snapshots. To use them, add the snapshot repository and depend on the development version:
5050

51-
Snapshot builds of the next development version are published to Maven Central Snapshots. To use them, add the repository and update the dependency version in your `pom.xml`:
51+
#### Maven
5252

5353
```xml
5454
<repositories>
@@ -66,9 +66,7 @@ Snapshot builds of the next development version are published to Maven Central S
6666
</dependency>
6767
```
6868

69-
### Gradle
70-
71-
Replace `${copilot.sdk.version}` with the latest release from Maven Central.
69+
#### Gradle
7270

7371
```groovy
7472
implementation 'com.github:copilot-sdk-java:1.0.14-preview.5-SNAPSHOT'

0 commit comments

Comments
 (0)