diff --git a/README.md b/README.md index 19e92e16b..a360a1c7a 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ The SDK supports multiple authentication methods: - **Environment variables** - `COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, `GITHUB_TOKEN` - **BYOK** - Use your own API keys (no GitHub auth required) -See the **[Authentication documentation](./docs/auth/index.md)** for details on each method. +See the **[Authentication documentation](./docs/auth/README.md)** for details on each method. ### Do I need to install the Copilot CLI separately? @@ -125,11 +125,11 @@ Please use the [GitHub Issues](https://github.com/github/copilot-sdk/issues) pag ## Quick Links -- **[Documentation](./docs/index.md)** – Full documentation index +- **[Documentation](./docs/README.md)** – Full documentation index - **[Getting Started](./docs/getting-started.md)** – Tutorial to get up and running -- **[Setup Guides](./docs/setup/index.md)** – Architecture, deployment, and scaling -- **[Authentication](./docs/auth/index.md)** – GitHub OAuth, BYOK, and more -- **[Features](./docs/features/index.md)** – Hooks, custom agents, MCP, skills, and more +- **[Setup Guides](./docs/setup/README.md)** – Architecture, deployment, and scaling +- **[Authentication](./docs/auth/README.md)** – GitHub OAuth, BYOK, and more +- **[Features](./docs/features/README.md)** – Hooks, custom agents, MCP, skills, and more - **[Troubleshooting](./docs/troubleshooting/debugging.md)** – Common issues and solutions - **[Cookbook](https://github.com/github/awesome-copilot/blob/main/cookbook/copilot-sdk)** – Practical recipes for common tasks across all languages - **[More Resources](https://github.com/github/awesome-copilot/blob/main/collections/copilot-sdk.md)** – Additional examples, tutorials, and community resources diff --git a/docs/index.md b/docs/README.md similarity index 86% rename from docs/index.md rename to docs/README.md index 9abc943f5..3d46fe9ab 100644 --- a/docs/index.md +++ b/docs/README.md @@ -7,9 +7,9 @@ Welcome to the GitHub Copilot SDK docs. Whether you're building your first Copil | I want to... | Go to | |---|---| | **Build my first app** | [Getting Started](./getting-started.md)—end-to-end tutorial with streaming & custom tools | -| **Set up for production** | [Setup Guides](./setup/index.md)—architecture, deployment patterns, scaling | -| **Configure authentication** | [Authentication](./auth/index.md)—GitHub OAuth, environment variables, BYOK | -| **Add features to my app** | [Features](./features/index.md)—hooks, custom agents, MCP, skills, and more | +| **Set up for production** | [Setup Guides](./setup/README.md)—architecture, deployment patterns, scaling | +| **Configure authentication** | [Authentication](./auth/README.md)—GitHub OAuth, environment variables, BYOK | +| **Add features to my app** | [Features](./features/README.md)—hooks, custom agents, MCP, skills, and more | | **Debug an issue** | [Troubleshooting](./troubleshooting/debugging.md)—common problems and solutions | ## Documentation map @@ -18,7 +18,7 @@ Welcome to the GitHub Copilot SDK docs. Whether you're building your first Copil Step-by-step tutorial that takes you from zero to a working Copilot app with streaming responses and custom tools. -### [Setup](./setup/index.md) +### [Setup](./setup/README.md) How to configure and deploy the SDK for your use case. @@ -30,14 +30,14 @@ How to configure and deploy the SDK for your use case. * [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 -### [Authentication](./auth/index.md) +### [Authentication](./auth/README.md) Configuring how users and services authenticate with Copilot. -* [Authentication Overview](./auth/index.md): methods, priority order, and examples +* [Authentication Overview](./auth/README.md): methods, priority order, and examples * [Bring Your Own Key (BYOK)](./auth/byok.md): use your own API keys from OpenAI, Azure, Anthropic, and more -### [Features](./features/index.md) +### [Features](./features/README.md) Guides for building with the SDK's capabilities. @@ -54,7 +54,7 @@ Guides for building with the SDK's capabilities. * [Cloud Sessions](./features/cloud-sessions.md): run sessions on GitHub-hosted compute with the cloud: option * [Fleet Mode](./features/fleet-mode.md): dispatch parallel sub-agents for parallelizable work -### [Hooks Reference](./hooks/index.md) +### [Hooks Reference](./hooks/README.md) Detailed API reference for each session hook. diff --git a/docs/auth/index.md b/docs/auth/README.md similarity index 100% rename from docs/auth/index.md rename to docs/auth/README.md diff --git a/docs/auth/byok.md b/docs/auth/byok.md index 6f2d20633..1bf364664 100644 --- a/docs/auth/byok.md +++ b/docs/auth/byok.md @@ -612,5 +612,5 @@ foundry model run phi-4-mini ## Next steps -* [Authentication Overview](./index.md) - Learn about all authentication methods +* [Authentication Overview](./README.md) - Learn about all authentication methods * [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app diff --git a/docs/features/index.md b/docs/features/README.md similarity index 96% rename from docs/features/index.md rename to docs/features/README.md index d6a560fc1..fe2a98c2e 100644 --- a/docs/features/index.md +++ b/docs/features/README.md @@ -24,7 +24,7 @@ These guides cover the capabilities you can add to your Copilot SDK application. ## Related -* [Hooks Reference](../hooks/index.md): detailed API reference for each hook type +* [Hooks Reference](../hooks/README.md): detailed API reference for each hook type * [Integrations](../integrations/microsoft-agent-framework.md): use the SDK with other platforms (MAF, etc.) * [Troubleshooting](../troubleshooting/debugging.md): when things don't work as expected * [Compatibility](../troubleshooting/compatibility.md): SDK vs CLI feature matrix diff --git a/docs/features/cloud-sessions.md b/docs/features/cloud-sessions.md index 6f9564911..0d670b996 100644 --- a/docs/features/cloud-sessions.md +++ b/docs/features/cloud-sessions.md @@ -381,4 +381,4 @@ Use remote sessions when the session should execute where the SDK runtime is alr * [Remote Sessions](./remote-sessions.md): share locally hosted sessions through Mission Control * [Streaming Events](./streaming-events.md): subscribe to `assistant.*` deltas for live UI rendering * [Multi-tenancy](../setup/multi-tenancy.md): integration IDs and server deployment patterns -* [Authentication](../auth/index.md): configure GitHub authentication for SDK sessions +* [Authentication](../auth/README.md): configure GitHub authentication for SDK sessions diff --git a/docs/hooks/index.md b/docs/hooks/README.md similarity index 100% rename from docs/hooks/index.md rename to docs/hooks/README.md diff --git a/docs/hooks/error-handling.md b/docs/hooks/error-handling.md index 471c9c426..e235b2ae5 100644 --- a/docs/hooks/error-handling.md +++ b/docs/hooks/error-handling.md @@ -514,6 +514,6 @@ const session = await client.createSession({ ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Session Lifecycle Hooks](./session-lifecycle.md) * [Debugging Guide](../troubleshooting/debugging.md) \ No newline at end of file diff --git a/docs/hooks/post-tool-use.md b/docs/hooks/post-tool-use.md index 86473c0a2..45964b034 100644 --- a/docs/hooks/post-tool-use.md +++ b/docs/hooks/post-tool-use.md @@ -507,6 +507,6 @@ const session = await client.createSession({ ## See also -- [Hooks Overview](./index.md) +- [Hooks Overview](./README.md) - [Pre-Tool Use Hook](./pre-tool-use.md) - [Error Handling Hook](./error-handling.md) \ No newline at end of file diff --git a/docs/hooks/pre-tool-use.md b/docs/hooks/pre-tool-use.md index c2ab0b0ba..4abe2a052 100644 --- a/docs/hooks/pre-tool-use.md +++ b/docs/hooks/pre-tool-use.md @@ -454,6 +454,6 @@ const session = await client.createSession({ ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Post-Tool Use Hook](./post-tool-use.md) * [Debugging Guide](../troubleshooting/debugging.md) \ No newline at end of file diff --git a/docs/hooks/session-lifecycle.md b/docs/hooks/session-lifecycle.md index aed71132e..21c9bdcf6 100644 --- a/docs/hooks/session-lifecycle.md +++ b/docs/hooks/session-lifecycle.md @@ -554,6 +554,6 @@ Session Summary: ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Error Handling Hook](./error-handling.md) * [Debugging Guide](../troubleshooting/debugging.md) diff --git a/docs/hooks/user-prompt-submitted.md b/docs/hooks/user-prompt-submitted.md index edb6c7a3f..49930ba4a 100644 --- a/docs/hooks/user-prompt-submitted.md +++ b/docs/hooks/user-prompt-submitted.md @@ -496,6 +496,6 @@ const session = await client.createSession({ ## See also -* [Hooks Overview](./index.md) +* [Hooks Overview](./README.md) * [Session Lifecycle Hooks](./session-lifecycle.md) * [Pre-Tool Use Hook](./pre-tool-use.md) \ No newline at end of file diff --git a/docs/integrations/index.md b/docs/integrations/README.md similarity index 100% rename from docs/integrations/index.md rename to docs/integrations/README.md diff --git a/docs/observability/index.md b/docs/observability/README.md similarity index 100% rename from docs/observability/index.md rename to docs/observability/README.md diff --git a/docs/setup/index.md b/docs/setup/README.md similarity index 100% rename from docs/setup/index.md rename to docs/setup/README.md diff --git a/docs/setup/multi-tenancy.md b/docs/setup/multi-tenancy.md index 74e828ba7..def44746e 100644 --- a/docs/setup/multi-tenancy.md +++ b/docs/setup/multi-tenancy.md @@ -454,4 +454,4 @@ Use these rules: * [BYOK](../auth/byok.md): using your own model provider credentials * [Cloud Sessions](../features/cloud-sessions.md): routing selected work to cloud sessions * [Session Persistence](../features/session-persistence.md): managing resumable session state -* [Features overview](../features/index.md): tools, events, hooks, and advanced SDK features +* [Features overview](../features/README.md): tools, events, hooks, and advanced SDK features diff --git a/docs/troubleshooting/index.md b/docs/troubleshooting/README.md similarity index 100% rename from docs/troubleshooting/index.md rename to docs/troubleshooting/README.md