Skip to content

docs: align Java SDK documentation - #987

Merged
jonathannorris merged 3 commits into
mainfrom
docs-sdk-java
Aug 7, 2026
Merged

docs: align Java SDK documentation#987
jonathannorris merged 3 commits into
mainfrom
docs-sdk-java

Conversation

@jonathannorris

@jonathannorris jonathannorris commented Aug 6, 2026

Copy link
Copy Markdown
Member

Summary

  • Replace exact Java SDK versions with the compatible Maven-style range [2.9.3,3.0.0).
  • Apply the range consistently to Maven, Gradle, and OpenFeature installation examples.
  • Document that the range includes 2.9.3 and excludes 3.0.0.
  • Document client shutdown for background workers and connections.

Validation

  • git diff --check passed.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploying devcycle-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 333a862
Status: ✅  Deploy successful!
Preview URL: https://7a3bc381.devcycle-docs.pages.dev
Branch Preview URL: https://docs-sdk-java.devcycle-docs.pages.dev

View logs

@jonathannorris
jonathannorris marked this pull request as ready for review August 6, 2026 18:20
Copilot AI review requested due to automatic review settings August 6, 2026 18:20

Copilot AI 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.

Pull request overview

Updates the Java Server SDK documentation to use a consistent, compatible Maven/Gradle version range and adds guidance for properly shutting down the SDK client to stop background workers.

Changes:

  • Replaced “LATEST” / Gradle + dependency versions with the Maven-style range [2.9.3,3.0.0) for Java Server SDK installs.
  • Applied the same range consistently across the Java install and Java OpenFeature Provider docs (Maven + Gradle).
  • Added a client.close() shutdown note to help users stop polling/connection/queue background work during application shutdown.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/sdk/server-side-sdks/java/java-usage.md Adds client shutdown guidance (client.close()) to prevent lingering background workers.
docs/sdk/server-side-sdks/java/java-openfeature.md Aligns OpenFeature install examples (Maven/Gradle) to use [2.9.3,3.0.0) and documents the bounds.
docs/sdk/server-side-sdks/java/java-install.md Aligns core Java SDK install examples (Maven/Gradle) to use [2.9.3,3.0.0) and documents the bounds.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/sdk/server-side-sdks/java/java-usage.md
Comment thread docs/sdk/server-side-sdks/java/java-install.md
@jonathannorris
jonathannorris enabled auto-merge (squash) August 7, 2026 17:45
@jonathannorris
jonathannorris merged commit 43650a1 into main Aug 7, 2026
5 checks passed
@jonathannorris
jonathannorris deleted the docs-sdk-java branch August 7, 2026 17:48
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.

3 participants