Skip to content

docs: add in-process runtime guide - #2595

Open
patniko wants to merge 1 commit into
mainfrom
docs/in-process-runtime-guide
Open

docs: add in-process runtime guide#2595
patniko wants to merge 1 commit into
mainfrom
docs/in-process-runtime-guide

Conversation

@patniko

@patniko patniko commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • explain when to host the Copilot runtime in process
  • document configuration for all six SDKs
  • cover native runtime resolution, lifecycle behavior, and experimental limitations

Validation

  • git diff --check
  • docs validation passed for TypeScript, Python, Go, and C#
  • Java docs validation was not run because Maven is unavailable in the local environment

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings September 9, 2026 18:38
@patniko
patniko requested a review from a team as a code owner September 9, 2026 18:38

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.

Copilot review overview

🟡 Changes recommended

The Java example lacks its required experimental opt-in, and the promised setup comparison does not include this deployment model.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review tier: Balanced
Findings: 1 Medium severity · 1 Low severity

New issues introduced by this change (2)
Severity Finding
Medium severity docs/​setup/​in-process-runtime.md — This Java example is not usable as shown: RuntimeConnection/forInProcess() are guarded by…
Low severity docs/​setup/​in-process-runtime.md — The linked “Choosing a setup path” page currently contains no in-process option, so it does not…
What changed in this PR

Adds a setup guide for hosting the Copilot runtime inside an application process.

Changes:

  • Documents architecture and use cases.
  • Provides configuration for six SDKs.
  • Covers resolution, lifecycle, deployment, and limitations.
File Description
docs/​setup/​in-process-runtime.md Adds the in-process runtime guide.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +147 to +149
```java
CopilotClientOptions options = new CopilotClientOptions()
.setConnection(RuntimeConnection.forInProcess());

## Further reading

* [Choosing a setup path](./choosing-a-setup-path.md): compare in-process hosting with other deployment models
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.

2 participants