Skip to content

Commit 4dc1512

Browse files
sunbryeCopilot
andcommitted
Convert callout syntax to GitHub-flavored alerts
Convert 27 callouts across 15 files from bold-text style (> **Note:**) to GitHub alert syntax (> [!NOTE]). Language-qualified tips (e.g., > **Tip (Python / Go):**) preserve the qualifier as bold text in the alert body. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 15649ff commit 4dc1512

15 files changed

Lines changed: 54 additions & 27 deletions

‎docs/auth/byok.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,8 @@ provider: {
293293
}
294294
```
295295

296-
> **Note:** Foundry Local starts on a **dynamic port** — the port is not fixed. Use `foundry service status` to confirm the port the service is currently listening on, then use that port in your `baseUrl`.
296+
> [!NOTE]
297+
> Foundry Local starts on a **dynamic port** — the port is not fixed. Use `foundry service status` to confirm the port the service is currently listening on, then use that port in your `baseUrl`.
297298
298299
To get started with Foundry Local:
299300

@@ -334,7 +335,8 @@ provider: {
334335
}
335336
```
336337

337-
> **Note:** The `bearerToken` option accepts a **static token string** only. The SDK does not refresh this token automatically. If your token expires, requests will fail and you'll need to create a new session with a fresh token.
338+
> [!NOTE]
339+
> The `bearerToken` option accepts a **static token string** only. The SDK does not refresh this token automatically. If your token expires, requests will fail and you'll need to create a new session with a fresh token.
338340
339341
## Custom model listing
340342

‎docs/features/custom-agents.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,8 @@ try (var client = new CopilotClient()) {
254254
| `infer` | `boolean` | | Whether the runtime can auto-select this agent (default: `true`) |
255255
| `skills` | `string[]` | | Skill names to preload into the agent's context at startup |
256256

257-
> **Tip:** A good `description` helps the runtime match user intent to the right agent. Be specific about the agent's expertise and capabilities.
257+
> [!TIP]
258+
> A good `description` helps the runtime match user intent to the right agent. Be specific about the agent's expertise and capabilities.
258259
259260
In addition to per-agent configuration above, you can set `agent` on the **session config** itself to pre-select which custom agent is active when the session starts. See [Selecting an Agent at Session Creation](#selecting-an-agent-at-session-creation) below.
260261

@@ -757,7 +758,8 @@ const session = await client.createSession({
757758
});
758759
```
759760

760-
> **Note:** When `tools` is `null` or omitted, the agent inherits access to all tools configured on the session. Use explicit tool lists to enforce the principle of least privilege.
761+
> [!NOTE]
762+
> When `tools` is `null` or omitted, the agent inherits access to all tools configured on the session. Use explicit tool lists to enforce the principle of least privilege.
761763
762764
## Agent-exclusive tools
763765

@@ -905,7 +907,8 @@ Precedence:
905907
1. Session-level `availableTools`/`excludedTools` are applied first (globally)
906908
2. `defaultAgent.excludedTools` is applied on top, further restricting the main agent only
907909

908-
> **Note:** If a tool is in both `excludedTools` (session-level) and `defaultAgent.excludedTools`, the session-level exclusion takes precedence — the tool is unavailable to everyone.
910+
> [!NOTE]
911+
> If a tool is in both `excludedTools` (session-level) and `defaultAgent.excludedTools`, the session-level exclusion takes precedence — the tool is unavailable to everyone.
909912
910913
## Attaching MCP servers to agents
911914

‎docs/features/hooks.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,8 @@ try (var client = new CopilotClient()) {
223223

224224
</details>
225225

226-
> **Tip:** Every hook handler receives an `invocation` parameter containing the `sessionId`, which is useful for correlating logs and maintaining per-session state.
226+
> [!TIP]
227+
> Every hook handler receives an `invocation` parameter containing the `sessionId`, which is useful for correlating logs and maintaining per-session state.
227228
228229
---
229230

‎docs/features/mcp.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
The Copilot SDK can integrate with **MCP servers** (Model Context Protocol) to extend the assistant's capabilities with external tools. MCP servers run as separate processes and expose tools (functions) that Copilot can invoke during conversations.
44

5-
> **Note:** This is an evolving feature. See [issue #36](https://github.com/github/copilot-sdk/issues/36) for ongoing discussion.
5+
> [!NOTE]
6+
> This is an evolving feature. See [issue #36](https://github.com/github/copilot-sdk/issues/36) for ongoing discussion.
67
78
## What is MCP?
89

@@ -240,7 +241,8 @@ and subdirectories including temporary system files, log files, and
240241
directories for different applications.
241242
```
242243

243-
> **Tip:** You can use any MCP server from the [MCP Servers Directory](https://github.com/modelcontextprotocol/servers). Popular options include `@modelcontextprotocol/server-github`, `@modelcontextprotocol/server-sqlite`, and `@modelcontextprotocol/server-puppeteer`.
244+
> [!TIP]
245+
> You can use any MCP server from the [MCP Servers Directory](https://github.com/modelcontextprotocol/servers). Popular options include `@modelcontextprotocol/server-github`, `@modelcontextprotocol/server-sqlite`, and `@modelcontextprotocol/server-puppeteer`.
244246
245247
## Configuration options
246248

‎docs/features/session-persistence.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,8 @@ Each SDK also provides idiomatic automatic cleanup patterns:
418418
| **C#** | `IAsyncDisposable` | `await using var session = await client.CreateSessionAsync(config);` |
419419
| **Go** | `defer` | `defer session.Disconnect()` |
420420

421-
> **Note:** `destroy()` is deprecated in favor of `disconnect()`. Existing code using `destroy()` will continue to work but should be migrated.
421+
> [!NOTE]
422+
> `destroy()` is deprecated in favor of `disconnect()`. Existing code using `destroy()` will continue to work but should be migrated.
422423
423424
### Permanently deleting a session (`deleteSession`)
424425

@@ -443,7 +444,8 @@ const client = new CopilotClient({
443444

444445
When a timeout is configured, sessions without activity for that duration are automatically cleaned up. Set to `0` or omit to disable.
445446

446-
> **Note:** This option only applies when the SDK spawns the runtime process. When connecting to an existing server via `cliUrl`, the server's own timeout configuration applies.
447+
> [!NOTE]
448+
> This option only applies when the SDK spawns the runtime process. When connecting to an existing server via `cliUrl`, the server's own timeout configuration applies.
447449
448450
```mermaid
449451
flowchart LR
@@ -572,7 +574,8 @@ const session = await client.createSession({
572574
});
573575
```
574576

575-
> **Note:** Thresholds are context utilization ratios (0.0-1.0), not absolute token counts. See the [Compatibility Guide](../troubleshooting/compatibility.md) for details.
577+
> [!NOTE]
578+
> Thresholds are context utilization ratios (0.0-1.0), not absolute token counts. See the [Compatibility Guide](../troubleshooting/compatibility.md) for details.
576579
577580
## Limitations and considerations
578581

‎docs/features/skills.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,8 @@ const session = await client.createSession({
378378
onPermissionRequest: async () => ({ kind: "approved" }),
379379
});
380380
```
381-
> **Note:** Skills are opt-in — when `skills` is omitted, no skill content is injected. Sub-agents do not inherit skills from the parent; you must list them explicitly per agent.
381+
> [!NOTE]
382+
> Skills are opt-in — when `skills` is omitted, no skill content is injected. Sub-agents do not inherit skills from the parent; you must list them explicitly per agent.
382383
383384
### Skills + MCP servers
384385

‎docs/features/steering-and-queueing.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@ try (var client = new CopilotClient()) {
217217
3. The agent sees the steering message as a new user message and adjusts its response
218218
4. If the turn completes before the steering message is processed, it is automatically moved to the regular queue for the next turn
219219

220-
> **Note:** Steering messages are best-effort within the current turn. If the agent has already committed to a tool call, the steering takes effect after that call completes but still within the same turn.
220+
> [!NOTE]
221+
> Steering messages are best-effort within the current turn. If the agent has already committed to a tool call, the steering takes effect after that call completes but still within the same turn.
221222
222223
## Queueing (enqueue mode)
223224

@@ -624,7 +625,8 @@ class InteractiveChat {
624625
| `"enqueue"` | Queue for next turn | Waits in FIFO queue | Starts a new turn immediately |
625626
| `"immediate"` | Inject into current turn | Injected before next LLM call | Starts a new turn immediately |
626627

627-
> **Note:** When the session is idle (not processing), both modes behave identically — the message starts a new turn immediately.
628+
> [!NOTE]
629+
> When the session is idle (not processing), both modes behave identically — the message starts a new turn immediately.
628630
629631
## Best practices
630632

‎docs/features/streaming-events.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,11 +206,14 @@ session.on(AssistantMessageDeltaEvent.class, event ->
206206

207207
</details>
208208

209-
> **Tip (Python / Go):** These SDKs use a single `Data` class/struct with all possible fields as optional/nullable. Only the fields listed in the tables below are populated for each event type — the rest will be `None` / `nil`.
209+
> [!TIP]
210+
> **(Python / Go)** These SDKs use a single `Data` class/struct with all possible fields as optional/nullable. Only the fields listed in the tables below are populated for each event type — the rest will be `None` / `nil`.
210211
>
211-
> **Tip (.NET):** The .NET SDK uses separate, strongly-typed data classes per event (e.g., `AssistantMessageDeltaData`), so only the relevant fields exist on each type.
212+
> [!TIP]
213+
> **(.NET)** The .NET SDK uses separate, strongly-typed data classes per event (e.g., `AssistantMessageDeltaData`), so only the relevant fields exist on each type.
212214
>
213-
> **Tip (TypeScript):** The TypeScript SDK uses a discriminated union — when you match on `event.type`, the `data` payload is automatically narrowed to the correct shape.
215+
> [!TIP]
216+
> **(TypeScript)** The TypeScript SDK uses a discriminated union — when you match on `event.type`, the `data` payload is automatically narrowed to the correct shape.
214217
215218
---
216219

‎docs/getting-started.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1543,7 +1543,8 @@ const session = await client.createSession({
15431543
});
15441544
```
15451545

1546-
> **Tip:** You can also set `agent: "pr-reviewer"` in the session config to pre-select this agent from the start. See the [Custom Agents guide](./features/custom-agents.md#selecting-an-agent-at-session-creation) for details.
1546+
> [!TIP]
1547+
> You can also set `agent: "pr-reviewer"` in the session config to pre-select this agent from the start. See the [Custom Agents guide](./features/custom-agents.md#selecting-an-agent-at-session-creation) for details.
15471548
15481549
### Customize the system message
15491550

@@ -1606,7 +1607,8 @@ By default the headless server only accepts connections from loopback (`127.0.0.
16061607
copilot --headless --host 0.0.0.0 --port 4321
16071608
```
16081609

1609-
> **Warning:** Exposing the headless server on a non-loopback address makes it reachable by anyone who can route to that address. Pair it with network controls (firewall, private network, reverse proxy) and authentication appropriate for your environment.
1610+
> [!WARNING]
1611+
> Exposing the headless server on a non-loopback address makes it reachable by anyone who can route to that address. Pair it with network controls (firewall, private network, reverse proxy) and authentication appropriate for your environment.
16101612
16111613
### Connecting the SDK to the external server
16121614

‎docs/integrations/microsoft-agent-framework.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ The Microsoft Agent Framework is the unified successor to Semantic Kernel and Au
1313
| **Orchestrator** | A MAF component that coordinates agents in sequential, concurrent, or handoff workflows |
1414
| **A2A protocol** | Agent-to-Agent communication standard supported by the framework |
1515

16-
> **Note:** MAF integration packages are available for **.NET** and **Python**. For TypeScript, Go, and Java, use the Copilot SDK directly — the standard SDK APIs already provide tool calling, streaming, and custom agents.
16+
> [!NOTE]
17+
> MAF integration packages are available for **.NET** and **Python**. For TypeScript, Go, and Java, use the Copilot SDK directly — the standard SDK APIs already provide tool calling, streaming, and custom agents.
1718
1819
## Prerequisites
1920

@@ -49,7 +50,8 @@ pip install copilot-sdk agent-framework-github-copilot
4950
<details>
5051
<summary><strong>Java</strong></summary>
5152

52-
> **Note:** The Java SDK does not have a dedicated MAF integration package. Use the standard Copilot SDK directly — it provides tool calling, streaming, and custom agents out of the box.
53+
> [!NOTE]
54+
> The Java SDK does not have a dedicated MAF integration package. Use the standard Copilot SDK directly — it provides tool calling, streaming, and custom agents out of the box.
5355
5456
```xml
5557
<!-- Maven -->

0 commit comments

Comments
 (0)