Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions docs/index.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/auth/byok.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment on lines +615 to 616
2 changes: 1 addition & 1 deletion docs/features/index.md → docs/features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/features/cloud-sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/hooks/error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/hooks/post-tool-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Comment on lines +510 to 512
2 changes: 1 addition & 1 deletion docs/hooks/pre-tool-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/hooks/session-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/hooks/user-prompt-submitted.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/setup/multi-tenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
File renamed without changes.
Loading