Commit 14bf1f8
docs: refresh for GA; add cloud sessions, fleet mode, multi-tenancy guides (#1481)
* docs: refresh for GA; add cloud sessions, fleet mode, multi-tenancy guides
- Remove public/technical preview language across root + all SDK READMEs
- Match copilot-agent-runtime GA wording (lowercase 'generally available', no banners)
- Add docs/setup/multi-tenancy.md, docs/features/cloud-sessions.md, docs/features/fleet-mode.md
- Split cloud sessions out of remote-sessions.md
- Correct claims: .NET package name, Python install, Java version placeholder + JDK 21+,
Go ctx.Context signatures, Node TS 5.2+/Node 20+, Rust permission handler API
- Document skipPermission, per-session gitHubToken, BYOK wireApi,
assistant.usage.apiEndpoint, fleet-mode compatibility
- Mark java ADR-001 superseded by GA
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* docs(cloud-sessions): remove confusing remote-sessions/sandbox disambiguation intro
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* docs: validate new GA samples instead of using docs-validate: skip
Replace all 9 docs-validate: skip markers in cloud-sessions.md with the
hidden-full-snippet + visible-snippet pattern (or direct buildable
snippets), and fix latent validation failures in fleet-mode.md and
multi-tenancy.md (.NET undefined locals, Go missing package/imports,
TS plan-mode union literal).
- cloud-sessions.md: 0 skip markers remain
- fleet-mode.md: hidden Go/.NET wrappers for session+ctx; plan-mode
snippet now a valid type union
- multi-tenancy.md: hidden Go/.NET wrappers seed runtimeInstanceId,
runtimeUrl, user, requestId
Validation (TS / Python / Go / C#) passes for all three files; Java
validation requires mvn (only available in CI).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* docs: add plugin directories guide
New guide covering the --plugin-dir / extra-args path for loading bundled
plugin folders (skills, hooks, MCP, custom agents, LSP) from an SDK host
application. Covers folder layout, per-language wiring, plugin-dir vs
marketplace plugins, COPILOT_PLUGIN_DIR_ONLY for deterministic plugin
sets, session.plugins.list inspection, and troubleshooting.
Links added from docs/index.md and docs/features/index.md.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* docs: address PR review feedback for accuracy
Verified all 10 reviewer findings against source; all accurate. Applied fixes:
- backend-services.md: Replace 5 instances of the non-existent TS top-level
'cliUrl' option with 'connection: RuntimeConnection.forUri(...)' (matches
CopilotClientOptions in nodejs/src/types.ts).
- multi-tenancy.md: Drop baseDirectory/sessionIdleTimeoutSeconds from the TS
forUri sample and setCopilotHome/setSessionIdleTimeoutSeconds from the
Java setCliUrl sample (both ignored for URI connections; documented inline).
Fix SessionFsConfig field 'initialWorkingDirectory' -> 'initialCwd'
(matches nodejs/src/types.ts:2068). Remove 'or cliUrl' from the TS row
of the external-runtime table.
- streaming-events.md: Add 'ws:/responses' to assistant.usage.apiEndpoint
union (matches nodejs/src/generated/session-events.ts:231).
- fleet-mode.md: Fix Rust crate path 'github_copilot' -> 'github_copilot_sdk'
(rust/Cargo.toml lib name).
- cloud-sessions.md: Replace invalid Rust async closure permission handler
with Arc<dyn PermissionHandler> via ApproveAllHandler from handler module
(matches rust/src/types.rs:1529 signature).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* docs: fix docs-validate CI failures (Java + Python wrappers, remove last skip)
CI Validate-* jobs run with mvn installed (so real Java errors surfaced)
and mypy strict (so undefined module-level names surfaced):
- features/fleet-mode.md Python sub-agent events: wrap visible snippet
with hidden async main() that constructs session via CopilotClient.
- setup/multi-tenancy.md Java: add hidden compilable wrapper that defines
runtimeUrl/user/requestId stubs and switches wildcard import to
fully-qualified com.github.copilot.rpc imports.
- features/plugin-directories.md Java: fix wrong import
(com.github.copilot.CopilotClientOptions ->
com.github.copilot.rpc.CopilotClientOptions) and wrap in hidden
compilable class.
- features/plugin-directories.md Rust: remove last docs-validate: skip;
wrap with hidden tokio::main and keep visible excerpt.
All non-Java validators now clean locally; only env-only mvn errors remain.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* docs(cloud-sessions): add send-after-start, URL surfacing, and troubleshooting
Cover two real-world gotchas that the existing guide does not mention:
1. "Sending the first prompt" — explains that createSession returns
before the remote worker connects, so the first session.send must
await session.start{producer:'copilot-agent'}. Without it the runtime
silently swallows the prompt (RemoteSession.sendForSchema is
fire-and-forget) and the developer sees a resolved messageId but no
assistant.* events and no prompt in Mission Control. Also notes that
streaming:true is needed for assistant.message_delta.
2. "Accessing the Mission Control URL" — cloud sessions auto-publish a
shareable URL via session.info{infoType:'remote', url}. Apps should
subscribe to that event rather than calling remote.enable(), which is
only for promoting local sessions.
Add three matching rows to the Troubleshooting table and a Streaming
Events link in See Also.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Update cloud-sessions.md
---------
Co-authored-by: Patrick <patrick@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>1 parent da1788d commit 14bf1f8
33 files changed
Lines changed: 1726 additions & 190 deletions
File tree
- docs
- auth
- features
- hooks
- observability
- setup
- troubleshooting
- dotnet
- go
- java
- docs/adr
- nodejs
- docs
- python
- rust
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
| 14 | + | |
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
91 | | - | |
| 91 | + | |
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
| |||
117 | 117 | | |
118 | 118 | | |
119 | 119 | | |
120 | | - | |
| 120 | + | |
121 | 121 | | |
122 | 122 | | |
123 | 123 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
300 | 300 | | |
301 | 301 | | |
302 | 302 | | |
303 | | - | |
| 303 | + | |
304 | 304 | | |
305 | 305 | | |
306 | 306 | | |
307 | 307 | | |
308 | 308 | | |
309 | 309 | | |
| 310 | + | |
| 311 | + | |
310 | 312 | | |
311 | 313 | | |
312 | 314 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
205 | 205 | | |
206 | 206 | | |
207 | 207 | | |
208 | | - | |
| 208 | + | |
209 | 209 | | |
210 | 210 | | |
211 | 211 | | |
212 | 212 | | |
213 | 213 | | |
214 | 214 | | |
215 | | - | |
216 | | - | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
217 | 219 | | |
218 | 220 | | |
219 | 221 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
0 commit comments