Skip to content

Commit 4d53780

Browse files
sunbryeCopilot
andcommitted
Convert headings to sentence case across all SDK docs
Convert 402 headings from title case to sentence case across 31 markdown files to align with docs.github.com style conventions. Proper nouns (GitHub, Copilot, OAuth, Azure, MCP, etc.) and code identifiers (SessionConfig, TelemetryConfig, etc.) are preserved. Ampersands replaced with 'and'. No code snippet contents modified. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 79dc615 commit 4d53780

31 files changed

Lines changed: 583 additions & 583 deletions

docs/auth/byok.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# BYOK (Bring Your Own Key)
1+
# BYOK (bring your own key)
22

33
BYOK allows you to use the Copilot SDK with your own API keys from model providers, bypassing GitHub Copilot authentication. This is useful for enterprise deployments, custom model hosting, or when you want direct billing with your model provider.
44

5-
## Supported Providers
5+
## Supported providers
66

77
| Provider | Type Value | Notes |
88
|----------|------------|-------|
@@ -13,7 +13,7 @@ BYOK allows you to use the Copilot SDK with your own API keys from model provide
1313
| Microsoft Foundry Local | `"openai"` | Run AI models locally on your device via OpenAI-compatible API |
1414
| Other OpenAI-compatible | `"openai"` | vLLM, LiteLLM, etc. |
1515

16-
## Quick Start: Azure AI Foundry
16+
## Quick start: Azure AI Foundry
1717

1818
Azure AI Foundry (formerly Azure OpenAI) is a common BYOK deployment target for enterprises. Here's a complete example:
1919

@@ -196,9 +196,9 @@ client.stop().get();
196196

197197
</details>
198198

199-
## Provider Configuration Reference
199+
## Provider configuration reference
200200

201-
### ProviderConfig Fields
201+
### ProviderConfig fields
202202

203203
| Field | Type | Description |
204204
|-------|------|-------------|
@@ -209,14 +209,14 @@ client.stop().get();
209209
| `wireApi` / `wire_api` | `"completions"` \| `"responses"` | API format (default: `"completions"`) |
210210
| `azure.apiVersion` / `azure.api_version` | string | Azure API version (default: `"2024-10-21"`) |
211211

212-
### Wire API Format
212+
### Wire API format
213213

214214
The `wireApi` setting determines which OpenAI API format to use:
215215

216216
- **`"completions"`** (default) - Chat Completions API (`/chat/completions`). Use for most models.
217217
- **`"responses"`** - Responses API. Use for GPT-5 series models that support the newer responses format.
218218

219-
### Type-Specific Notes
219+
### Type-specific notes
220220

221221
**OpenAI (`type: "openai"`)**
222222
- Works with OpenAI API and any OpenAI-compatible endpoint
@@ -231,9 +231,9 @@ The `wireApi` setting determines which OpenAI API format to use:
231231
- For direct Anthropic API access
232232
- Uses Claude-specific API format
233233

234-
## Example Configurations
234+
## Example configurations
235235

236-
### OpenAI Direct
236+
### OpenAI direct
237237

238238
```typescript
239239
provider: {
@@ -243,7 +243,7 @@ provider: {
243243
}
244244
```
245245

246-
### Azure OpenAI (Native Azure Endpoint)
246+
### Azure OpenAI (native Azure endpoint)
247247

248248
Use `type: "azure"` for endpoints at `*.openai.azure.com`:
249249

@@ -258,7 +258,7 @@ provider: {
258258
}
259259
```
260260

261-
### Azure AI Foundry (OpenAI-Compatible Endpoint)
261+
### Azure AI Foundry (OpenAI-compatible endpoint)
262262

263263
For Azure AI Foundry deployments with `/openai/v1/` endpoints, use `type: "openai"`:
264264

@@ -271,7 +271,7 @@ provider: {
271271
}
272272
```
273273

274-
### Ollama (Local)
274+
### Ollama (local)
275275

276276
```typescript
277277
provider: {
@@ -322,7 +322,7 @@ provider: {
322322
}
323323
```
324324

325-
### Bearer Token Authentication
325+
### Bearer token authentication
326326

327327
Some providers require bearer token authentication instead of API keys:
328328

@@ -336,7 +336,7 @@ provider: {
336336

337337
> **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.
338338
339-
## Custom Model Listing
339+
## Custom model listing
340340

341341
When using BYOK, the CLI server may not know which models your provider supports. You can supply a custom `onListModels` handler at the client level so that `client.listModels()` returns your provider's models in the standard `ModelInfo` format. This lets downstream consumers discover available models without querying the CLI.
342342

@@ -473,13 +473,13 @@ Results are cached after the first call, just like the default behavior. The han
473473

474474
When using BYOK, be aware of these limitations:
475475

476-
### Identity Limitations
476+
### Identity limitations
477477

478478
BYOK authentication uses **static credentials only**.
479479

480480
You must use an API key or static bearer token that you manage yourself.
481481

482-
### Feature Limitations
482+
### Feature limitations
483483

484484
Some Copilot features may behave differently with BYOK:
485485

@@ -488,7 +488,7 @@ Some Copilot features may behave differently with BYOK:
488488
- **Usage tracking** - Usage is tracked by your provider, not GitHub Copilot
489489
- **Premium requests** - Do not count against Copilot premium request quotas
490490

491-
### Provider-Specific Limitations
491+
### Provider-specific limitations
492492

493493
| Provider | Limitations |
494494
|----------|-------------|
@@ -499,7 +499,7 @@ Some Copilot features may behave differently with BYOK:
499499

500500
## Troubleshooting
501501

502-
### "Model not specified" Error
502+
### "Model not specified" error
503503

504504
When using BYOK, the `model` parameter is **required**:
505505

@@ -516,7 +516,7 @@ const session = await client.createSession({
516516
});
517517
```
518518

519-
### Azure Endpoint Type Confusion
519+
### Azure endpoint type confusion
520520

521521
For Azure OpenAI endpoints (`*.openai.azure.com`), use the correct type:
522522

@@ -574,7 +574,7 @@ provider: {
574574
}
575575
```
576576

577-
### Connection Refused (Ollama)
577+
### Connection refused (Ollama)
578578

579579
Ensure Ollama is running and accessible:
580580

@@ -586,7 +586,7 @@ curl http://localhost:11434/v1/models
586586
ollama serve
587587
```
588588

589-
### Connection Refused (Foundry Local)
589+
### Connection refused (Foundry Local)
590590

591591
Foundry Local uses a dynamic port that may change between restarts. Confirm the active port:
592592

@@ -601,13 +601,13 @@ Update your `baseUrl` to match the port shown in the output. If the service is n
601601
foundry model run phi-4-mini
602602
```
603603

604-
### Authentication Failed
604+
### Authentication failed
605605

606606
1. Verify your API key is correct and not expired
607607
2. Check the `baseUrl` matches your provider's expected format
608608
3. For bearer tokens, ensure the full token is provided (not just a prefix)
609609

610-
## Next Steps
610+
## Next steps
611611

612612
- [Authentication Overview](./index.md) - Learn about all authentication methods
613613
- [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app

docs/auth/index.md

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

33
The GitHub Copilot SDK supports multiple authentication methods to fit different use cases. Choose the method that best matches your deployment scenario.
44

5-
## Authentication Methods
5+
## Authentication methods
66

77
| Method | Use Case | Copilot Subscription Required |
88
|--------|----------|-------------------------------|
@@ -11,7 +11,7 @@ The GitHub Copilot SDK supports multiple authentication methods to fit different
1111
| [Environment Variables](#environment-variables) | CI/CD, automation, server-to-server | Yes |
1212
| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Azure AI Foundry, OpenAI, etc.) | No |
1313

14-
## GitHub Signed-in User
14+
## GitHub signed-in user
1515

1616
This is the default authentication method when running the Copilot CLI interactively. Users authenticate via GitHub OAuth device flow, and the SDK uses their stored credentials.
1717

@@ -231,7 +231,7 @@ client.start().get();
231231
- SaaS applications building on top of Copilot
232232
- Any multi-user application where you need to make requests on behalf of different users
233233

234-
## Environment Variables
234+
## Environment variables
235235

236236
For automation, CI/CD pipelines, and server-to-server scenarios, you can authenticate using environment variables.
237237

@@ -279,7 +279,7 @@ await client.start()
279279
- Server-side applications with service accounts
280280
- Development when you don't want to use interactive login
281281

282-
## BYOK (Bring Your Own Key)
282+
## BYOK (bring your own key)
283283

284284
BYOK allows you to use your own API keys from model providers like Azure AI Foundry, OpenAI, or Anthropic. This bypasses GitHub Copilot authentication entirely.
285285

@@ -295,7 +295,7 @@ BYOK allows you to use your own API keys from model providers like Azure AI Foun
295295
- Limitations and considerations
296296
- Complete code examples
297297

298-
## Authentication Priority
298+
## Authentication priority
299299

300300
When multiple authentication methods are available, the SDK uses them in this priority order:
301301

@@ -306,7 +306,7 @@ When multiple authentication methods are available, the SDK uses them in this pr
306306
5. **Stored OAuth credentials** - From previous `copilot` CLI login
307307
6. **GitHub CLI** - `gh auth` credentials
308308

309-
## Disabling Auto-Login
309+
## Disabling auto-login
310310

311311
To prevent the SDK from automatically using stored credentials or `gh` CLI auth, use the `useLoggedInUser: false` option:
312312

@@ -395,7 +395,7 @@ client.start().get();
395395

396396
</details>
397397

398-
## Next Steps
398+
## Next steps
399399

400400
- [BYOK Documentation](./byok.md) - Learn how to use your own API keys
401401
- [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app

0 commit comments

Comments
 (0)