Skip to content

docs: correct Java bundled runtime setup - #2819

Open
rinceyuan wants to merge 1 commit into
github:mainfrom
rinceyuan:docs/java-bundled-runtime
Open

rinceyuan wants to merge 1 commit into
github:mainfrom
rinceyuan:docs/java-bundled-runtime

Conversation

@rinceyuan

Copy link
Copy Markdown
Contributor

Summary

  • Replace the outdated claim that Java cannot bundle the CLI with the platform-classifier runtime dependency requirement.
  • Explain that managed Java connections extract copilot-runtime and runtime.node, and retain the explicit path and existing-server override options.
  • Use the default CopilotClient constructor in the bundled-runtime quick start instead of requiring an external CLI path. Keep Java setup prose outside the language tabs.

The current CliServerManager.resolveCliLaunch implementation falls back to NativeRuntimeLoader.resolveRuntimeWrapper, and existing loader tests cover extracting the adjacent runtime pair. This only updates the setup guide; it does not change runtime behavior or enable in-process mode.

Fixes #2795.

Validation

  • npm run docs:java with Temurin JDK 25: SDK build succeeded; all 33 Java documentation examples compiled.
  • Checked the Java runtime dependency link and heading anchor; existing page headings are unchanged.
  • git diff --check passed.

The docs task skips Java tests and native artifact downloads. This verifies documentation compilation, not a live CLI launch. No dependency manifests, generated sources, or other documentation files changed.

@rinceyuan
rinceyuan requested a review from a team as a code owner October 8, 2026 05:41
Copilot AI balanced review requested due to automatic review settings October 8, 2026 05:41

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.

🟢 Approval recommended

The documentation matches the Java runtime loader behavior and established setup guidance.

0 open findings

What changed in this PR

Updates bundled-runtime documentation to reflect Java’s platform-specific runtime JAR support.

Changes:

  • Documents Java runtime dependency and override options.
  • Updates runtime behavior explanation.
  • Uses the default Java client constructor.
File Description
docs/​setup/​bundled-cli.md Corrects Java bundled-runtime setup and quick start.

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

This branch has not been deployed

No deployments
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.

[Java] [Docs] Java documentation here is still saying the Java SDK does not bundle the CLI at all:

2 participants