diff --git a/.github/instructions/docs-style.instructions.md b/.github/instructions/docs-style.instructions.md index 7f586e85d..16dbe2709 100644 --- a/.github/instructions/docs-style.instructions.md +++ b/.github/instructions/docs-style.instructions.md @@ -10,7 +10,7 @@ This style guide applies to all documentation in the `docs/` directory. These do Use **sentence case** for all headings. Capitalize only the first word and proper nouns. -* `## Quick start: Azure AI Foundry` — not `## Quick Start: Azure AI Foundry` +* `## Quick start: Microsoft Foundry` — not `## Quick Start: Microsoft Foundry` * `# Custom agents and sub-agent orchestration` — not `# Custom Agents & Sub-Agent Orchestration` Use `and` instead of `&` in headings. diff --git a/README.md b/README.md index 43ff70deb..5ad2b7127 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Billing for the GitHub Copilot SDK is based on the same model as the Copilot CLI ### Does it support BYOK (Bring Your Own Key)? -Yes, the GitHub Copilot SDK supports BYOK (Bring Your Own Key). You can configure the SDK to use your own API keys from supported LLM providers (e.g. OpenAI, Azure AI Foundry, Anthropic) to access models through those providers. See the **[BYOK documentation](./docs/auth/byok.md)** for setup instructions and examples. +Yes, the GitHub Copilot SDK supports BYOK (Bring Your Own Key). You can configure the SDK to use your own API keys from supported LLM providers (e.g. OpenAI, Microsoft Foundry, Anthropic) to access models through those providers. See the **[BYOK documentation](./docs/auth/byok.md)** for setup instructions and examples. **Note:** BYOK uses key-based authentication only. Microsoft Entra ID (Azure AD), managed identities, and third-party identity providers are not supported. diff --git a/docs/README.md b/docs/README.md index 74736509e..ebb287d98 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,7 +26,7 @@ How to configure and deploy the SDK for your use case. * [Local CLI](./setup/local-cli.md): use your own CLI binary or running instance * [Backend Services](./setup/backend-services.md): server-side with headless CLI over TCP * [GitHub OAuth](./setup/github-oauth.md): implement the OAuth flow -* [Azure Managed Identity](./setup/azure-managed-identity.md): BYOK with Azure AI Foundry +* [Azure Managed Identity](./setup/azure-managed-identity.md): BYOK with Microsoft Foundry * [Scaling & Multi-Tenancy](./setup/scaling.md): horizontal scaling, isolation patterns * [Multi-Tenancy & Server Deployments](./setup/multi-tenancy.md): mode: "empty", session isolation, integration IDs, sessionFs diff --git a/docs/auth/authenticate.md b/docs/auth/authenticate.md index 97492c1fc..d54c95451 100644 --- a/docs/auth/authenticate.md +++ b/docs/auth/authenticate.md @@ -10,7 +10,7 @@ The GitHub Copilot SDK supports multiple authentication methods to fit different | [OAuth GitHub App](#oauth-github-app) | Apps acting on behalf of users via OAuth | Yes | | [Environment Variables](#environment-variables) | CI/CD, automation, server-to-server | Yes | | [Server-to-server authentication](./server-to-server-tokens.md) | Organization-attributed automation and direct organization billing | No user subscription; organization policy required | -| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Azure AI Foundry, OpenAI, and more) | No | +| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Microsoft Foundry, OpenAI, and more) | No | ## GitHub signed-in user @@ -285,16 +285,16 @@ await client.start() ## BYOK (bring your own key) -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. +BYOK allows you to use your own API keys from model providers like Microsoft Foundry, OpenAI, or Anthropic. This bypasses GitHub Copilot authentication entirely. **Key benefits:** * No GitHub Copilot subscription required * Use enterprise model deployments * Direct billing with your model provider -* Support for Azure AI Foundry, OpenAI, Anthropic, and OpenAI-compatible endpoints +* Support for Microsoft Foundry, OpenAI, Anthropic, and OpenAI-compatible endpoints **See the [BYOK documentation](./byok.md) for complete details**, including: -* Azure AI Foundry setup +* Microsoft Foundry setup * Provider configuration options * Limitations and considerations * Complete code examples diff --git a/docs/getting-started.md b/docs/getting-started.md index b4dc5d6c2..53b6497fd 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2264,7 +2264,7 @@ Trace context is propagated automatically—no manual instrumentation is needed: ## Learn more * [Authentication Guide](./auth/authenticate.md) - GitHub OAuth, environment variables, and BYOK -* [BYOK (Bring Your Own Key)](./auth/byok.md) - Use your own API keys from Azure AI Foundry, OpenAI, etc. +* [BYOK (Bring Your Own Key)](./auth/byok.md) - Use your own API keys from Microsoft Foundry, OpenAI, etc. * [Node.js SDK Reference](../nodejs/README.md) * [Python SDK Reference](../python/README.md) * [Go SDK Reference](../go/README.md) diff --git a/docs/setup/README.md b/docs/setup/README.md index cc4183ca7..e4723ab48 100644 --- a/docs/setup/README.md +++ b/docs/setup/README.md @@ -8,5 +8,5 @@ Configure and deploy the GitHub Copilot SDK for your use case. * [Backend services](./backend-services.md): server-side with headless CLI over TCP * [Multi-tenancy and server deployments](./multi-tenancy.md): SDK options for multi-user server mode * [GitHub OAuth](./github-oauth.md): implement the OAuth flow -* [Azure managed identity](./azure-managed-identity.md): BYOK with Azure AI Foundry +* [Azure managed identity](./azure-managed-identity.md): BYOK with Microsoft Foundry * [Scaling and multi-tenancy](./scaling.md): horizontal scaling, isolation patterns